This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
polynomialmani.pl/polymani.pl
2018-11-23 18:18:15 +00:00

721 lines
18 KiB
Prolog

%% -*- mode: prolog-*-
%% vim: set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
/**
*
* polimani.pl
*
* Assignment 1 - Polynomial Manipulator
* Programming in Logic - DCC-FCUP
*
* Diogo Peralta Cordeiro
* up201705417@fc.up.pt
*
* Hugo David Cordeiro Sales
* up201704178@fc.up.pt
*
*********************************************
* Follows 'Coding guidelines for Prolog' *
* https://doi.org/10.1017/S1471068411000391 *
*********************************************/
/*
* Import the Constraint Logic Programming over Finite Domains library
* Essentially, this library improves the way Prolog deals with integers,
* allowing more predicates to be reversible.
* For instance, number(N) is always false, which prevents the
* reversing of a predicate.
*/
:- use_module(library(clpfd)).
/*******************************
* USER INTERFACE *
*******************************/
/*
poly2list/2 transforms a list representing a polynomial (second
argument) into a polynomial represented as an expression (first
argument) and vice-versa.
*/
poly2list(P, L) :-
is_term_valid_in_predicate(P, "poly2list"),
polynomial_to_list(P, L),
!.
/*
simpolylist/2 simplifies a polynomial represented as a list into
another polynomial as a list.
*/
simpoly_list(L, S) :-
is_polynomial_list_valid_in_predicate(L, "simpoly_list"), %TODO IMPLEMENT
simplify_polynomial_as_list(L, S),
!.
/*
simpoly/2 simplifies a polynomial represented as an expression
as another polynomial as an expression.
*/
simpoly(P, S) :-
is_term_valid_in_predicate(P, "simpoly"),
simplify_polynomial(P, S),
!.
/*
scalepoly/3 multiplies a polynomial represented as an expression by a scalar
resulting in a second polynomial. The two first arguments are assumed to
be ground. The polynomial resulting from the sum is in simplified form.
*/
scalepoly(P1, P2, S) :-
is_term_valid_in_predicate(P1, "scalepoly"),
is_term_valid_in_predicate(P2, "scalepoly"),
scale_polynomial(P1, P2, S),
!.
/*
addpoly/3 adds two polynomials as expressions resulting in a
third one. The two first arguments are assumed to be ground.
The polynomial resulting from the sum is in simplified form.
*/
addpoly(P1, P2, S) :-
is_term_valid_in_predicate(P1, "addpoly"),
is_term_valid_in_predicate(P2, "addpoly"),
add_polynomial(P1, P2, S),
!.
/*******************************
* BACKEND *
*******************************/
%% polynomial_variable_list(-List) is det
%
% List of possible polynomial variables
%
polynomial_variable_list([x, y, z]).
%% polynomial_variable(?X:atom) is semidet
%
% Returns true if X is a polynomial variable, false otherwise.
%
polynomial_variable(X) :-
polynomial_variable_list(V),
member(X, V).
%% Tests:
%% ?- polynomial_variable(x).
%@ true .
%% ?- polynomial_variable(a).
%@ false.
%% power(+X:atom) is semidet
%
% Returns true if X is a power term, false otherwise.
%
power(P^N) :-
(
N #>= 1,
%% zcompare((<), -1, N),
polynomial_variable(P)
;
fail
).
power(X) :-
polynomial_variable(X).
%% Tests:
%% ?- power(x).
%@ true .
%% ?- power(a).
%@ false.
%% ?- power(x^1).
%@ true .
%% ?- power(x^3).
%@ true .
%% ?- power(x^(-3)).
%@ false.
%% ?- power(X).
%@ X = x^_2420,
%@ _2420 in 0..sup ;
%@ X = y^_2420,
%@ _2420 in 0..sup ;
%@ X = z^_2420,
%@ _2420 in 0..sup ;
%@ X = x ;
%@ X = y ;
%@ X = z.
%% term(+N:atom) is semidet
%
% Returns true if N is a term, false otherwise.
%
term(N) :-
(
% If N is non a free variable
nonvar(N),
% Assert it as a number
number(N)
);
(
% If N is a free variable
not(compound(N)),
var(N),
% Assert it must be between negative and positive infinity
% This uses the CLP(FD) library, which makes this reversible,
% whereas `number(N)` is always false, since it only succeeds
% if the argument is bound to a intger or float
N in inf..sup
).
term(X) :-
power(X).
term(L * R) :-
term(L),
term(R).
%% Tests:
%% ?- term(2*x^3).
%@ true .
%% ?- term(x^(-3)).
%@ false.
%% ?- term(a).
%@ false.
%% ?- term(-1*x).
%@ true .
%% ?- term((-3)*x^2).
%@ true .
%% ?- term(3.2*x).
%@ true .
%% ?- term(X).
%@ X in inf..sup ;
%@ X = x^_1242,
%@ _1242 in 1..sup ;
%@ X = y^_1242,
%@ _1242 in 1..sup ;
%@ X = z^_1242,
%@ _1242 in 1..sup ;
%@ X = x ;
%@ X = y ;
%@ X = z ;
%@ X = _1330*_1332,
%@ _1330 in inf..sup,
%@ _1332 in inf..sup ;
%@ X = _1406*x^_1414,
%@ _1406 in inf..sup,
%@ _1414 in 1..sup ;
%@ X = _1406*y^_1414,
%@ _1406 in inf..sup,
%@ _1414 in 1..sup ;
%@ X = _1406*z^_1414,
%@ _1406 in inf..sup,
%@ _1414 in 1..sup ;
%@ X = _1188*x,
%@ _1188 in inf..sup .
%% Doesn't give all possible terms, because number(N) is not reversible
%% is_term_valid_in_predicate(+T, +F) is det
%
% Returns true if valid Term, fails with UI message otherwise.
% The fail message reports which Term is invalid and in which
% predicate the problem ocurred.
%
is_term_valid_in_predicate(P, _) :-
%% If P is a valid polynomial, return true
polynomial(P),
!.
is_term_valid_in_predicate(P, F) :-
%% Writes the polynomial and fails otherwise
write("Invalid polynomial in "),
write(F),
write(": "),
write(P),
fail.
%% Tests:
%% ?- is_term_valid_in_predicate(1, "Test").
%@ true.
%% ?- is_term_valid_in_predicate(a*4-0*x, "Test").
%@ Invalid polynomial in Test: a*4-0*x
%@ false.
%% polynomial(+M:atom) is semidet
%
% Returns true if polynomial, false otherwise.
%
polynomial(M) :-
%% A polynomial is either a term
term(M).
polynomial(L + R) :-
%% Or a sum of terms
polynomial(L),
term(R).
polynomial(L - R) :-
%% Or a subtraction of terms
polynomial(L),
term(R).
%% Tests:
%% ?- polynomial(x).
%@ true .
%% ?- polynomial(x^3).
%@ true .
%% ?- polynomial(3*x^7).
%@ true .
%% ?- polynomial(2 + 3*x + 4*x*y^3).
%@ true .
%% ?- polynomial(2 - 3*x + 4*x*y^3).
%@ true .
%% ?- polynomial(a).
%@ false.
%% ?- polynomial(x^(-3)).
%@ false.
%% power_to_canon(+T:atom, -T^N:atom) is semidet
%
% Returns a canon power term.
%
power_to_canon(T^N, T^N) :-
polynomial_variable(T),
% CLP(FD) operator to ensure N is different from 1,
% in a reversible way
N #\= 1.
power_to_canon(T, T^1) :-
polynomial_variable(T).
%% Tests:
%% ?- power_to_canon(x, X).
%@ X = x^1 .
%% ?- power_to_canon(X, x^1).
%@ X = x .
%% ?- power_to_canon(X, x^4).
%@ X = x^4 .
%% ?- power_to_canon(X, a^1).
%@ false.
%% ?- power_to_canon(X, x^(-3)).
%@ X = x^ -3 .
%% term_to_list(?T, ?List) is semidet
%
% Converts a term to a list and vice versa.
% A term is multiplication of a number or a power
% and another term
% Can verify if term and list are compatible.
%
term_to_list(L * N, [N | TS]) :-
number(N),
term_to_list(L, TS).
term_to_list(L * P, [P2 | TS]) :-
power(P),
power_to_canon(P, P2),
term_to_list(L, TS).
term_to_list(N, [N]) :-
number(N).
term_to_list(P, [P2]) :-
power(P),
power_to_canon(P, P2).
%% Tests:
%% ?- term_to_list(1, X).
%@ X = [1] .
%% ?- term_to_list(-1, X).
%@ X = [-1] .
%% ?- term_to_list(2 * 3, X).
%@ X = [3, 2] .
%% ?- term_to_list(1*2*y*z*23*x*y*x^3*x, X).
%@ X = [x^1, x^3, y^1, x^1, 23, z^1, y^1, 2, 1] .
%% ?- term_to_list(1*2*y*z*23*x*y*(-1), X).
%@ X = [-1, y^1, x^1, 23, z^1, y^1, 2, 1] .
%% ?- term_to_list(X, [-1]).
%@ X = -1 .
%% ?- term_to_list(X, [x^1, -1]).
%@ X = -1*x .
%% ?- term_to_list(X, [y^1, x^1]).
%@ X = x*y .
%% ?- term_to_list(X, [x^4]).
%@ X = x^4 .
%% ?- term_to_list(X, [y^6, z^2, x^4]).
%@ X = x^4*z^2*y^6 .
%% ?- term_to_list(X, [y^6, z^2, x^4, -2]).
%@ X = -2*x^4*z^2*y^6 .
%% simplify_term(+Term_In:term, ?Term_Out:term) is det
%
% Simplifies a term.
%
simplify_term(Term_In, Term_Out) :-
term_to_list(Term_In, L),
%% Sort the list of numbers and power to group them,
%% simplifying the job of `join_similar_parts_of_term`
sort(0, @=<, L, L2),
(
%% If there's a 0 in the list, then the whole term is 0
member(0, L2),
Term_Out = 0
;
%% Otherwise
(
%% If there's only one element, then the term was already simplified
%% This is done so that the `exclude` following doesn't remove all ones
length(L2, 1),
Term_Out = Term_In
;
%% Remove all remaining ones
exclude(==(1), L2, L3),
join_similar_parts_of_term(L3, L4),
%% Reverse the list, since the following call gives the result in the
%% reverse order otherwise
reverse(L4, L5),
term_to_list(Term_Out, L5)
)
),
% First result is always the most simplified form.
!.
%% Tests:
%% ?- simplify_term(1, X).
%@ X = 1.
%% ?- simplify_term(x, X).
%@ X = x.
%% ?- simplify_term(2*y*z*x^3*x, X).
%@ X = 2*x^4*y*z.
%% ?- simplify_term(1*y*z*x^3*x, X).
%@ X = x^4*y*z.
%% ?- simplify_term(0*y*z*x^3*x, X).
%@ X = 0.
%% ?- simplify_term(6*y*z*7*x*y*x^3*x, X).
%@ X = 42*x^5*y^2*z.
%% ?- simplify_term(a, X).
%@ false.
%% ?- simplify_term(x^(-3), X).
%@ false.
%% join_similar_parts_of_term(+List, -List) is det
%
% Combine powers of the same variable in the given list
%
join_similar_parts_of_term([P1, P2 | L], L2) :-
%% If both symbols are powers
power(P1),
power(P2),
%% Decompose them into their parts
B^N1 = P1,
B^N2 = P2,
%% Sum the exponent
N is N1 + N2,
join_similar_parts_of_term([B^N | L], L2),
% First result is always the most simplified form.
!.
join_similar_parts_of_term([N1, N2 | L], L2) :-
%% If they are both numbers
number(N1),
number(N2),
%% Multiply them
N is N1 * N2,
join_similar_parts_of_term([N | L], L2),
% First result is always the most simplified form.
!.
join_similar_parts_of_term([X | L], [X | L2]) :-
join_similar_parts_of_term(L, L2),
% First result is always the most simplified form.
!.
join_similar_parts_of_term([], []).
%% Tests:
%% ?- join_similar_parts_of_term([3], T).
%@ T = [3].
%% ?- join_similar_parts_of_term([x^2], T).
%@ T = [x^2].
%% ?- join_similar_parts_of_term([x^1, x^1, x^1, x^1], T).
%@ T = [x^4].
%% ?- join_similar_parts_of_term([2, 3, x^1, x^2], T).
%@ T = [6, x^3].
%% ?- join_similar_parts_of_term([2, 3, x^1, x^2, y^1, y^6], T).
%@ T = [6, x^3, y^7].
%% simplify_polynomial(+P:atom, -P2:atom) is det
%
% Simplifies a polynomial.
%
simplify_polynomial(0, 0) :-
% 0 is already fully simplified and is an
% exception to the following algorithm
!.
simplify_polynomial(P, P2) :-
polynomial_to_list(P, L),
simplify_polynomial_as_list(L, L2),
list_to_polynomial(L2, P2),
%% The first result is the most simplified one
!.
%% Tests:
%% ?- simplify_polynomial(1, X).
%@ X = 1.
%% ?- simplify_polynomial(0, X).
%@ X = 0.
%% ?- simplify_polynomial(x, X).
%@ X = x.
%% ?- simplify_polynomial(x*x, X).
%@ X = x^2.
%% ?- simplify_polynomial(2 + 2, X).
%@ X = 2*2.
%% ?- simplify_polynomial(x + x, X).
%@ X = 2*x.
%% ?- simplify_polynomial(0 + x*x, X).
%@ X = x^2.
%% ?- simplify_polynomial(x^2*x + 3*x^3, X).
%@ X = 4*x^3.
%% ?- simplify_polynomial(x^2*x + 3*x^3 + x^3 + x*x*x, X).
%@ X = 6*x^3.
%% ?- simplify_polynomial(x^2*x + 3*x^3 + x^3 + x*x*4 + z, X).
%@ X = 5*x^3+4*x^2+z.
%% ?- simplify_polynomial(x^2*x + 3*x^3 - x^3 - x*x*4 + z, X).
%@ X = 3*x^3-4*x^2+z.
%% ?- simplify_polynomial(x + 1 + x, X).
%@ X = 2*x+1.
%% ?- simplify_polynomial(x + 1 + x + 1 + x + 1 + x, X).
%@ X = 4*x+3.
%% simplify_polynomial_as_list(+L1:List,-L3:List) is det
%
% Simplifies a polynomial represented as a list
%
simplify_polynomial_as_list(L, L11) :-
%% Convert each term to a list
maplist(term_to_list, L, L2),
%% Sort each sublist; done so the next
%% sort gives the correct results
maplist(sort(0, @>=), L2, L3),
%% Sort the outer list
sort(0, @>=, L3, L4),
%% For each of the parts of the terms, join them
maplist(join_similar_parts_of_term, L4, L5),
%% Sort each of the sublists
%% Done so the next call simplifies has less work
maplist(sort(0, @=<), L5, L6),
join_similar_terms(L6, L7),
%% Reverse each sublist, because the next call
%% reverses the result
maplist(reverse, L7, L8),
maplist(term_to_list, L9, L8),
%% Delete any 0 from the list
delete(L9, 0, L10),
%% Sort list converting back gives the result in the correct order
sort(0, @=<, L10, L11).
%% Tests:
%% ?- simplify_polynomial_as_list([x, 1, x^2, x*y, 3*x^2, 4*x], L).
%@ L = [1, 4*x^2, 5*x, x*y] .
%% ?- simplify_polynomial_as_list([1, x^2, x*y, 3*x^2, -4, -1*x], L).
%@ L = [-3, -1*x, 4*x^2, x*y] .
%% join_similar_terms(+P:ListList, -P2:ListList) is det
%
% Joins similar sublists representing terms by using
% `add_terms` to check if they can be merged and perform
% the addition. Requires the list of list be sorted with
% `maplist(sort(0, @>=), L, L2),
% sort(0, @>=, L2, L3)`
% and that the sublists to be sorted with
% `sort(0, @=<)` since that is inherited from `add_terms`
%
join_similar_terms([TL, TR | L], L2) :-
%% Check if terms can be added and add them
add_terms(TL, TR, T2),
%% Recurse, accumulation on the first element
join_similar_terms([T2 | L], L2),
%% Give only first result. Red cut
!.
join_similar_terms([X | L], [X | L2]) :-
%% If a pair of elements can't be added, skip one
%% and recurse
join_similar_terms(L, L2),
%% Give only first result. Red cut
!.
join_similar_terms([], []).
%% Tests:
%% ?- join_similar_terms([[2, x^3], [3, x^3], [x^3]], L).
%@ L = [[6, x^3]].
%% term_to_canon(+T:List, -T2:List) is det
%
% Adds a 1 if there's no number in the list
% Requires the list to be sorted such that the
% numbers come first. For instance with
% `sort(0, @=<)`
%
term_to_canon([T | TS], [1, T | TS]) :-
%% Since the list is sorted, if the first element
%% is not a number, then we need to add the 1
not(number(T)),
%% Give only first result. Red cut
!.
term_to_canon([T | TS], [N, T | TS]) :-
%% Since the list is sorted, if the first element
%% is not a number, then we need to add the 1
not(number(T)),
N is -1,
%% Give only first result. Red cut
!.
term_to_canon(L, L).
%% Tests:
%% ?- term_to_canon([2], T).
%@ T = [2].
%% ?- term_to_canon([x^3], T).
%@ T = [1, x^3].
%% ?- term_to_canon([x^3, z], T).
%@ T = [1, x^3, z].
%% ?- term_to_canon([2, x^3], T).
%@ T = [2, x^3].
%% add_terms(+L:List, +R:List, -Result:List) is det
%
% Adds two terms represented as list by adding
% the coeficients if the power is the same.
% Requires the list of terms to be simplified.
%
add_terms([NL | TL], [NR | TR], [N2 | TL2]) :-
%% Convert each term to a canon form. This ensures they
%% have a number in front, so it can be added
term_to_canon([NL | TL], [NL2 | TL2]),
term_to_canon([NR | TR], [NR2 | TR2]),
%% If they rest of the term is the same
TL2 == TR2,
%% Add the coeficients
N2 is NL2 + NR2.
%% Tests
%% ?- add_terms([1], [1], R).
%@ R = [2].
%% ?- add_terms([x], [x], R).
%@ R = [2, x].
%% ?- add_terms([2, x^3], [x^3], R).
%@ R = [3, x^3].
%% ?- add_terms([2, x^3], [3, x^3], R).
%@ R = [5, x^3].
%% polynomial_to_list(+P:polynomial, -L:List) is det
%
% Converts a polynomial in a list.
%
polynomial_to_list(L - T, [T2 | LS]) :-
term(T),
negate_term(T, T2),
polynomial_to_list(L, LS),
!.
polynomial_to_list(L + T, [T | LS]) :-
term(T),
polynomial_to_list(L, LS),
!.
polynomial_to_list(T, [T]) :-
term(T),
!.
%% Tests:
%% ?- polynomial_to_list(2, S).
%@ S = [2].
%% ?- polynomial_to_list(x^2, S).
%@ S = [x^2].
%% ?- polynomial_to_list(x^2 + x^2, S).
%@ S = [x^2, x^2].
%% ?- polynomial_to_list(2*x^2+5+y*2, S).
%@ S = [y*2, 5, 2*x^2].
%% ?- polynomial_to_list(2*x^2+5-y*2, S).
%@ S = [-2*y, 5, 2*x^2].
%% ?- polynomial_to_list(2*x^2-5-y*2, S).
%@ S = [-2*y, -5, 2*x^2].
%% ?- polynomial_to_list(2*x^2+3*x+5*x^17-7*x^21+3*x^3-23*x^4+25*x^5-4.3, S).
%@ S = [-4.3, 25*x^5, -23*x^4, 3*x^3, -7*x^21, 5*x^17, 3*x, 2* ... ^ ...].
%% list_to_polynomial(+P:polynomial, -L:List) is det
%
% Converts a list in a polynomial.
%
list_to_polynomial([T1|T2], P) :-
list_to_polynomial(T2, L1),
(
not(L1 = []),
(
term_string(T1, S1),
string_chars(S1, [First|_]),
First = -,
term_string(L1, S2),
string_concat(S2,S1,S3),
term_string(P, S3)
;
P = L1+T1
)
;
P = T1
),
% The others computations are semantically meaningless
!.
list_to_polynomial(T, P) :-
P = T.
%% Tests:
%% ?- list_to_polynomial([1, x, x^2], P).
%@ P = x^2+x+1.
%% negate_term(T, T2) is det
%
% Negate the coeficient of a term and return the negated term
%
negate_term(T, T2) :-
term_to_list(T, L),
%% Sort the list, so the coeficient is the first element
sort(0, @=<, L, L2),
%% Ensure there is a coeficient
term_to_canon(L2, L3),
[N | R] = L3,
%% (-)/1 is an operator, needs to be evaluated, otherwise
%% it gives a symbolic result, which messes with further processing
N2 is -N,
%% Reverse the order of the list, because converting
%% implicitly reverses it
reverse([N2 | R], L4),
term_to_list(T2, L4),
!.
%% Tests:
%% ?- negate_term(1, R).
%@ R = -1.
%% ?- negate_term(x, R).
%@ R = -1*x.
%% ?- negate_term(x^2, R).
%@ R = -1*x^2.
%% ?- negate_term(3*x*y^2, R).
%@ R = -3*x*y^2.
%% scale_polynomial(+P:polynomial,+C:constant,-S:polynomial) is det
%
% Multiplies a polynomial by a scalar
%
scale_polynomial(P, C, S) :-
polynomial_to_list(P, L),
%% Convert each term to a list
maplist(term_to_list, L, L2),
%% Append C to the start of each sublist
maplist(cons(C), L2, L3),
%% Convert back
maplist(term_to_list, L4, L3),
%% Simplify the resulting polynomial
simplify_polynomial_as_list(L4, L5),
list_to_polynomial(L5, S),
!.
%% Tests:
%% ?- scale_polynomial(3*x^2, 2, S).
%@ S = 6*x^2.
%% cons(+C:atom, +L:List, -L2:List) is det
%
% Add an atom C to the head of a list L
%
cons(C, L, [C | L]).
%% add_polynomial(+P1:polynomial,+P2:polynomial,-S:polynomial) is det
%
% S = P1 + P2
%
add_polynomial(P1, P2, S) :-
%% Convert both polynomials to lists
polynomial_to_list(P1, L1),
polynomial_to_list(P2, L2),
%% Join them
append(L1, L2, L3),
%% Simplify the resulting polynomial
simplify_polynomial_as_list(L3, L4),
%% Convert back
list_to_polynomial(L4, S),
!.
%% Tests:
%% ?- add_polynomial(2, 2, S).
%@ S = 4.
%% ?- add_polynomial(x, x, S).
%@ S = 2*x.
%% ?- add_polynomial(2*x+5*z, 2*z+6*x, S).
%@ S = 8*x+7*z.