Ags.SolverPolynomial¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
The coefficient this solver polynomial is assigned to |
||
r/w |
The coefficient value |
||
r |
The exponent this solver polynomial is assigned to |
||
r |
The exponent value |
||
r/w |
The polynomial this solver polynomial is assigned to |
||
r/w |
The symbol this solver polynomial is assigned to |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
coefficient |
r |
||
coefficient_value |
r |
||
exponent |
r |
||
exponent_value |
r |
||
flags |
r |
||
gobject |
r |
||
obj_mutex |
r |
||
polynomial |
r |
||
symbol |
r |
Class Details¶
- class Ags.SolverPolynomial(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new()¶
- Returns:
the new instance
- Return type:
Instantiate a new
Ags.SolverPolynomial
.New in version 3.2.0.
- add(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the second summand- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform addition of self and polynomial_b. Both summands need to have the very same symbol and exponent, otherwise
None
returned and error is appropriately set.New in version 3.2.0.
- divide(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the divisor- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform division of self and polynomial_b.
New in version 3.2.0.
- extract_root(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the index of root- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform raising power of self and polynomial_b.
New in version 3.2.0.
- get_coefficient()¶
- Returns:
the coefficient
- Return type:
Get coefficient of self.
New in version 3.9.3.
- get_coefficient_value()¶
- Returns:
the coefficient value
- Return type:
Get coefficient value of self.
New in version 3.9.3.
- get_exponent()¶
- Returns:
the exponent
- Return type:
[
str
]
Get exponent of self.
New in version 3.9.3.
- get_polynomial()¶
- Returns:
the polynomial
- Return type:
Get polynomial of self.
New in version 3.9.3.
- multiply(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the second factor- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform multiplication of self and polynomial_b.
New in version 3.2.0.
- parse(polynomial)¶
- Parameters:
polynomial (
str
) – the polynomial as string
Parse polynomial and apply to self.
New in version 3.2.0.
- raise_power(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the exponent- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform raising power of self and polynomial_b.
New in version 3.2.0.
- set_coefficient(coefficient)¶
- Parameters:
coefficient (
str
) – the coefficient
Set coefficient of self.
New in version 3.9.3.
- set_coefficient_value(coefficient_value)¶
- Parameters:
coefficient_value (
Ags.Complex
) – the coefficient value
Set coefficient_value of self.
New in version 3.9.3.
- set_polynomial(polynomial)¶
- Parameters:
polynomial (
str
) – the polynomial
Set polynomial of self.
New in version 3.9.3.
- subtract(polynomial_b)¶
- Parameters:
polynomial_b (
Ags.SolverPolynomial
) – the subtrahend- Raises:
- Returns:
the newly instantiated
Ags.SolverPolynomial
orNone
- Return type:
Perform subtraction of self and polynomial_b. Both minuend and subtrahend need to have the very same symbol and exponent, otherwise
None
returned and error is appropriately set.New in version 3.2.0.
- update()¶
Update string representation of self.
New in version 3.2.0.
Property Details¶
- Ags.SolverPolynomial.props.coefficient¶
-
The assigned coefficient.
New in version 3.2.0.
- Ags.SolverPolynomial.props.coefficient_value¶
- Name:
coefficient-value
- Type:
- Default Value:
- Flags:
Coefficient value.
New in version 3.2.0.
- Ags.SolverPolynomial.props.exponent¶
-
The assigned exponent.
New in version 3.2.0.
- Ags.SolverPolynomial.props.exponent_value¶
-
Exponent value.
New in version 3.2.0.
- Ags.SolverPolynomial.props.polynomial¶
-
The assigned polynomial.
New in version 3.2.0.