Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Add release note for polynomial symbol.
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
New attribute ``symbol`` added to polynomial classes | ||
---------------------------------------------------- | ||
|
||
The polynomial classes in the ``numpy.polynomial`` package have a new | ||
``symbol`` attribute which is used to represent the indeterminate | ||
of the polynomial. | ||
This can be used to change the value of the variable when printing:: | ||
|
||
>>> P_y = np.polynomial.Polynomial([1, 0, -1], symbol="y") | ||
>>> print(P_y) | ||
1.0 + 0.0·y¹ - 1.0·y² | ||
|
||
Note that the polynomial classes only support 1D polynomials, so operations | ||
that involve polynomials with different symbols are disallowed when the | ||
result would be multivariate:: | ||
|
||
>>> P = np.polynomial.Polynomial([1, -1]) # default symbol is "x" | ||
>>> P_z = np.polynomial.Polynomial([1, 1], symbol="z") | ||
>>> P * P_z | ||
Traceback (most recent call last) | ||
... | ||
ValueError: Polynomial symbols differ | ||
|
||
The symbol can be any valid Python identifier. The default is ``symbol=x``, | ||
consistent with existing behavior. |