Skip to content

Commit bf0c83b

Browse files
Alexey Stukalovalyst
authored andcommitted
get_degrees(): extend docstring
1 parent 6fb7e59 commit bf0c83b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/ordering.jl

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,17 @@
1717
"""
1818
$(SIGNATURES)
1919
20-
Internal function used for printing symbolic expressions. This function determines
21-
the degrees of symbols within a given expression, implementing a variation on
22-
degree lexicographic order.
20+
Get the degrees of symbols within a given expression.
21+
22+
This internal function is used to define the order of terms in a symbolic expression,
23+
which is a variation on degree lexicographic order. It is used for printing and
24+
by [`sorted_arguments`](@ref).
25+
26+
Returns a tuple of degree and lexicographically sorted *multiplier* ⇒ *power* pairs,
27+
where the *multiplier* is a tuple of the symbol optionally followed by its indices.
28+
For a sum expression, returns the `get_degrees()` result for term with the highest degree.
29+
30+
See also `monomial_lt` and `lexlt`.
2331
"""
2432
function get_degrees(expr)
2533
if issym(expr)

0 commit comments

Comments
 (0)