Skip to content

Clarify PcpElementByExponents(NC) and PcpElementByGenExpList(NC) documentation #4

@fingolfin

Description

@fingolfin

The documentation for PcpElementByExponents should explicitly state that it can be given an arbitrary exponent vector, which does not need to be in normal form; in particular, it performs collection. Similarly, PcpElementByGenExpList takes an arbitrary gen-exp list.

In contrast, PcpElementByExponentsNC does not perform collection, and assumes an exponent vector in normal form. Similarly PcpElementByGenExpListNC assumes that it is given a gen-exp list in "normal form".

This difference is IMHO not at all deducable from the current documentation text. Indeed, the paragraph just before the documentation for these two functions could be misunderstood as saying that an "exponent vector" always needs to be in normal form (suggesting that PcpElementByExponents does not perform collection).

Thus, we should consider adding explicit definitions for the term "normal form" applied to exponent vectors and gen-exp lists.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions