Expr
OCCT package Expr: Expr, Expr_Absolute, Expr_ArcCosine, Expr_ArcSine, and 54 more bound classes.
Expr
This package describes the data structure of any expression, relation or function used in mathematics. It also describes the assignment of variables. Standard mathematical functions are implemented such as trigonometrics, hyperbolics, and log functions.
Constructors(1)
- constructor(): Expr
Static methods(4)
- NbOfFreeVariables(exp: Expr_GeneralExpression): numberParameters (1)
exp
- NbOfFreeVariables(exp: Expr_GeneralRelation): numberParameters (1)
exp
- Sign(val: number): numberParameters (1)
val
Expr_Absolute
Constructors(1)
Creates the Abs of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArcCosine
Constructors(1)
Creates the Arccos of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArcSine
Constructors(1)
Creates the Arcsin of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArcTangent
Constructors(1)
Creates the Arctan of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArgCosh
Constructors(1)
Creates the ArgCosh of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArgSinh
Constructors(1)
Creates the ArgSinh of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ArgTanh
Constructors(1)
Creates the Argtanh of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_BinaryExpression
Defines all binary expressions. The order of the two operands is significant.
Static methods(2)
- get_type_name(): string
Instance methods(11)
- SetFirstOperand(exp: Expr_GeneralExpression): void
Sets first operand of <me> Raises InvalidOperand if exp = me.
Parameters (1)exp
- SetSecondOperand(exp: Expr_GeneralExpression): void
Sets second operand of <me> Raises InvalidOperand if <exp> contains <me>.
Parameters (1)exp
- NbSubExpressions(): number
returns the number of sub-expressions contained in <me> ( >= 0)
- SubExpression(I: number): Expr_GeneralExpression
returns the -th sub-expression of <me> raises OutOfRange if > NbSubExpressions(me)
Parameters (1)I
- ContainsUnknowns(): boolean
Does <me> contain NamedUnknown ?
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <me> contains <exp>.
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>. Raises InvalidOperand if <with> contains <me>.
Parameters (2)var_with_
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Expr_BinaryFunction
Defines the use of a binary function in an expression with given arguments.
Constructors(1)
- constructor(func: Expr_GeneralFunction, exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_BinaryFunction
Creates <me> as <func> (<exp1>,<exp2>). Raises exception if <func> is not binary.
Parameters (3)funcexp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns the function defining <me>.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Cosh
Constructors(1)
Creates the Cosh of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Cosine
Constructors(1)
Creates the cosine of Exp.
Parameters (1)Exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Difference
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Difference
Creates the difference <exp1> - <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.
Parameters (2)XN
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Different
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Different
Creates the relation <exp1> # <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_Division
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Division
Creates the division <exp1>/<exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Equal
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Equal
Creates the relation <exp1> = <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
returns a GeneralRelation after replacement of NamedUnknowns by an associated expression and after values computation.
- Simplify(): void
Replaces NamedUnknowns by an associated expressions and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_Exponential
Constructors(1)
Creates the exponential of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Exponentiate
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Exponentiate
Creates the exponential <exp1> ^ <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_ExprFailure
Constructors(2)
- constructor(theMessage: string): Expr_ExprFailureParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_ExprFailureParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_FunctionDerivative
Constructors(1)
- constructor(func: Expr_GeneralFunction, withX: Expr_NamedUnknown, deg: number): Expr_FunctionDerivative
Creates a FunctionDerivative of degree <deg> relative to the <withX> variable. Raises OutOfRange if <deg> lower or equal to zero.
Parameters (3)funcwithXdeg
Static methods(2)
- get_type_name(): string
Instance methods(15)
- NbOfVariables(): number
Returns the number of variables of <me>.
- Variable(index: number): Expr_NamedUnknown
Returns the variable denoted by <index> in <me>. Raises OutOfRange if <index> greater than NbOfVariables of <me>.
Parameters (1)index
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Computes the value of <me> with the given variables. Raises DimensionMismatch if Length(vars) is different from Length(values).
Parameters (2)varsvals
Returns a copy of <me> with the same form.
Returns Derivative of <me> for variable .
Parameters (1)var_
- Derivative(var_: Expr_NamedUnknown, deg: number): Expr_GeneralFunction
Returns Derivative of <me> for variable with degree <deg>.
Parameters (2)var_deg
- IsIdentical(func: Expr_GeneralFunction): boolean
Tests if <me> and <func> are similar functions (same name and same used expression).
Parameters (1)func
- IsLinearOnVariable(index: number): boolean
Tests if <me> is linear on variable on range <index>.
Parameters (1)index
Returns the function of which <me> is the derivative.
- Degree(): number
Returns the degree of derivation of <me>.
Returns the derivation variable of <me>.
- UpdateExpression(): void
Expr_GeneralExpression
Defines the general purposes of any expression.
Static methods(2)
- get_type_name(): string
Instance methods(17)
- NbSubExpressions(): number
Returns the number of sub-expressions contained in <me> ( >= 0).
- SubExpression(I: number): Expr_GeneralExpression
Returns the -th sub-expression of <me> raises OutOfRange if > NbSubExpressions(me).
Parameters (1)I
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- ContainsUnknowns(): boolean
Tests if <me> contains NamedUnknowns.
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. Warning: This method does not include any simplification before testing. It could also be very slow; to be used carefully.
Parameters (1)Other
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raise OutOfRange if N <= 0.
Parameters (2)XN
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with copies of <with> in <me>. Copies of <with> are made with the
Copy()method. Raises InvalidOperand if <with> contains <me>.Parameters (2)var_with_
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
- EvaluateNumeric(): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
returns a string representing <me> in a readable way.
Expr_GeneralFunction
Defines the general purposes of any function.
Static methods(2)
- get_type_name(): string
Instance methods(10)
- NbOfVariables(): number
Returns the number of variables of <me>.
- Variable(index: number): Expr_NamedUnknown
Returns the variable denoted by <index> in <me>. Raises OutOfRange if index > NbOfVariables.
Parameters (1)index
Returns a copy of <me> with the same form.
Returns Derivative of <me> for variable .
Parameters (1)var_
- Derivative(var_: Expr_NamedUnknown, deg: number): Expr_GeneralFunction
Returns Derivative of <me> for variable with degree <deg>.
Parameters (2)var_deg
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Computes the value of <me> with the given variables. Raises NotEvaluable if <vars> does not match all variables of <me>.
Parameters (2)varsvals
- IsIdentical(func: Expr_GeneralFunction): boolean
Tests if <me> and <func> are similar functions (same name and same used expression).
Parameters (1)func
- IsLinearOnVariable(index: number): boolean
Tests if <me> is linear on variable on range <index>.
Parameters (1)index
Expr_GeneralRelation
Defines the general purposes of any relation between expressions.
Static methods(2)
- get_type_name(): string
Instance methods(12)
- IsSatisfied(): boolean
Returns the current status of the relation.
- IsLinear(): boolean
Tests if <me> is linear between its NamedUnknowns.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
- NbOfSubRelations(): number
Returns the number of relations contained in <me>.
- NbOfSingleRelations(): number
Returns the number of SingleRelations contained in <me>.
- SubRelation(index: number): Expr_GeneralRelation
Returns the relation denoted by <index> in <me>. An exception is raised if <index> is out of range.
Parameters (1)index
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> contains .
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>.
Parameters (2)var_with_
returns a string representing <me> in a readable way.
Expr_GreaterThan
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_GreaterThan
Creates the relation <exp1> > <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_GreaterThanOrEqual
Constructors(1)
Creates the relation <exp1> >= <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_InvalidAssignment
Constructors(2)
- constructor(theMessage: string): Expr_InvalidAssignmentParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_InvalidAssignmentParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_InvalidFunction
Constructors(2)
- constructor(theMessage: string): Expr_InvalidFunctionParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_InvalidFunctionParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_InvalidOperand
Constructors(2)
- constructor(theMessage: string): Expr_InvalidOperandParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_InvalidOperandParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_LessThan
Constructors(1)
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_LessThan
Creates the relation <exp1> < <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_LessThanOrEqual
Constructors(1)
Creates the relation <exp1> <= <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(6)
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
returns a string representing <me> in a readable way.
Expr_LogOf10
Constructors(1)
Creates the base 10 logarithm of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_LogOfe
Constructors(1)
Creates the natural logarithm of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_NamedConstant
Describes any numeric constant known by a special name (as PI, e,...).
Constructors(1)
- constructor(name: TCollection_AsciiString, value: number): Expr_NamedConstant
Creates a constant value of name <name> and value .
Parameters (2)namevalue
Static methods(2)
- get_type_name(): string
Instance methods(14)
- GetValue(): number
- NbSubExpressions(): number
returns the number of sub-expressions contained in <me> (always returns zero)
- SubExpression(I: number): Expr_GeneralExpression
returns the -th sub-expression of <me> raises OutOfRange
Parameters (1)I
returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- ContainsUnknowns(): boolean
Tests if <me> contains NamedUnknown. (returns always False).
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.
Parameters (2)XN
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>.
Parameters (2)var_with_
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>.
Parameters (2)varsvals
Expr_NamedExpression
Describe an expression used by its name (as constants or variables). A single reference is made to a NamedExpression in every Expression (i.e. a NamedExpression is shared).
Static methods(2)
- get_type_name(): string
Instance methods(6)
- SetName(name: TCollection_AsciiString): voidParameters (1)
name
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
returns a string representing <me> in a readable way.
Expr_NamedFunction
Constructors(1)
- constructor(name: TCollection_AsciiString, exp: Expr_GeneralExpression, vars: NCollection_Array1_handle_Expr_NamedUnknown): Expr_NamedFunction
Creates a function of given variables <vars> with name <name> defined by the expression <exp>.
Parameters (3)nameexpvars
Static methods(2)
- get_type_name(): string
Instance methods(14)
- SetName(newname: TCollection_AsciiString): void
Sets the name <newname> to <me>.
Parameters (1)newname
Returns the name assigned to <me>.
- NbOfVariables(): number
Returns the number of variables of <me>.
- Variable(index: number): Expr_NamedUnknown
Returns the variable denoted by <index> in <me>. Raises OutOfRange if <index> is greater than NbOfVariables of <me>, or less than or equal to zero.
Parameters (1)index
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Computes the value of <me> with the given variables. Raises DimensionMismatch if Length(vars) is different from Length(values).
Parameters (2)varsvals
Returns a copy of <me> with the same form.
Returns Derivative of <me> for variable .
Parameters (1)var_
- Derivative(var_: Expr_NamedUnknown, deg: number): Expr_GeneralFunction
Returns Derivative of <me> for variable with degree <deg>.
Parameters (2)var_deg
- IsIdentical(func: Expr_GeneralFunction): boolean
Tests if <me> and <func> are similar functions (same name and same used expression).
Parameters (1)func
- IsLinearOnVariable(index: number): boolean
Tests if <me> is linear on variable on range <index>.
Parameters (1)index
Returns equivalent expression of <me>.
- SetExpression(exp: Expr_GeneralExpression): void
Modifies expression of <me>. Warning: Beware of derivatives. See FunctionDerivative.
Parameters (1)exp
Expr_NamedUnknown
This class describes any variable of an expression. Assignment is treated directly in this class.
Constructors(1)
- Parameters (1)
name
Static methods(2)
- get_type_name(): string
Instance methods(16)
- IsAssigned(): boolean
Tests if an expression is assigned to <me>.
If exists, returns the assigned expression. An exception is raised if the expression does not exist.
- Assign(exp: Expr_GeneralExpression): void
Assigns <me> to <exp> expression. Raises exception if <exp> refers to <me>.
Parameters (1)exp
- Deassign(): void
Suppresses the assigned expression.
- NbSubExpressions(): number
Returns the number of sub-expressions contained in <me> ( >= 0).
- SubExpression(I: number): Expr_GeneralExpression
Returns the -th sub-expression of <me> raises OutOfRange if > NbSubExpressions(me).
Parameters (1)I
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- ContainsUnknowns(): boolean
Tests if <me> contains NamedUnknown.
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.
Parameters (2)var_with_
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
Expr_NotAssigned
Constructors(2)
- constructor(theMessage: string): Expr_NotAssignedParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_NotAssignedParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_NotEvaluable
Constructors(2)
- constructor(theMessage: string): Expr_NotEvaluableParameters (1)
theMessage
- constructor(theMessage: string, theStackTrace: string): Expr_NotEvaluableParameters (2)
theMessagetheStackTrace
Instance methods(1)
- ExceptionType(): string
Expr_NumericValue
This class describes any reel value defined in an expression.
Constructors(1)
- constructor(val: number): Expr_NumericValueParameters (1)
val
Static methods(2)
- get_type_name(): string
Instance methods(17)
- GetValue(): number
- SetValue(val: number): voidParameters (1)
val
- NbSubExpressions(): number
Returns the number of sub-expressions contained in <me> ( >= 0).
- SubExpression(I: number): Expr_GeneralExpression
Returns the -th sub-expression of <me> raises OutOfRange if > NbSubExpressions(me).
Parameters (1)I
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- ContainsUnknowns(): boolean
Tests if <me> contains NamedUnknown.
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.
Parameters (2)XN
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>.
Parameters (2)var_with_
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_PolyExpression
Static methods(2)
- get_type_name(): string
Instance methods(10)
- NbOperands(): number
returns the number of operands contained in <me>
- Operand(index: number): Expr_GeneralExpression
Returns the <index>-th operand used in <me>. An exception is raised if index is out of range.
Parameters (1)index
- SetOperand(exp: Expr_GeneralExpression, index: number): void
Sets the <index>-th operand used in <me>. An exception is raised if <index> is out of range Raises InvalidOperand if <exp> contains <me>.
Parameters (2)expindex
- NbSubExpressions(): number
returns the number of sub-expressions contained in <me> ( >= 2)
- SubExpression(I: number): Expr_GeneralExpression
Returns the sub-expression denoted by in <me> Raises OutOfRange if > NbSubExpressions(me).
Parameters (1)I
- ContainsUnknowns(): boolean
Does <me> contains NamedUnknown ?
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.
Parameters (2)var_with_
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression and after values computation.
Expr_PolyFunction
Defines the use of an n-ary function in an expression with given arguments.
Constructors(1)
- constructor(func: Expr_GeneralFunction, exps: NCollection_Array1_handle_Expr_GeneralExpression): Expr_PolyFunction
Creates <me> as <func>(<exps_1>,<exps_2>,...,<exps_n>).
Parameters (2)funcexps
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns the function defining <me>.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Product
Constructors(2)
Creates the product of all members of sequence <exps>.
Parameters (1)exps
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Product
Creates the product of <exp1> and <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_RelationIterator
Iterates on every basic relation contained in a GeneralRelation.
Constructors(1)
- Parameters (1)
rel
Instance methods(3)
Expr_RUIterator
Iterates on NamedUnknowns in a GeneralRelation.
Constructors(1)
Creates an iterator on every NamedUnknown contained in <rel>.
Parameters (1)rel
Instance methods(3)
Expr_Sign
Constructors(1)
Creates the sign of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Sine
Constructors(1)
Creates the sine of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_SingleRelation
Static methods(2)
- get_type_name(): string
Instance methods(11)
- SetFirstMember(exp: Expr_GeneralExpression): void
Defines the first member of the relation.
Parameters (1)exp
- SetSecondMember(exp: Expr_GeneralExpression): void
Defines the second member of the relation.
Parameters (1)exp
Returns the first member of the relation.
Returns the second member of the relation.
- IsLinear(): boolean
Tests if <me> is linear between its NamedUnknowns.
- NbOfSubRelations(): number
Returns the number of relations contained in <me>.
- NbOfSingleRelations(): number
Returns the number of SingleRelations contained in <me> (Always 1).
- SubRelation(index: number): Expr_GeneralRelation
Returns the relation denoted by <index> in <me>. An exception is raised if index is out of range.
Parameters (1)index
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <me> contains <exp>.
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>.
Parameters (2)var_with_
Expr_Sinh
Constructors(1)
Creates the sinh of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Square
Constructors(1)
Creates the square of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_SquareRoot
Constructors(1)
Creates the square root of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Sum
Constructors(2)
Creates the sum of all the members of sequence <exps>.
Parameters (1)exps
- constructor(exp1: Expr_GeneralExpression, exp2: Expr_GeneralExpression): Expr_Sum
Creates the sum of <exp1> and <exp2>.
Parameters (2)exp1exp2
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.
Parameters (2)XN
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_SystemRelation
Constructors(1)
- constructor(relation: Expr_GeneralRelation): Expr_SystemRelation
Creates a system with one relation.
Parameters (1)relation
Static methods(2)
- get_type_name(): string
Instance methods(14)
- Add(relation: Expr_GeneralRelation): void
Appends <relation> in the list of components of <me>.
Parameters (1)relation
- Remove(relation: Expr_GeneralRelation): voidParameters (1)
relation
- IsLinear(): boolean
Tests if <me> is linear between its NamedUnknowns.
- NbOfSubRelations(): number
Returns the number of relations contained in <me>.
- NbOfSingleRelations(): number
Returns the number of SingleRelations contained in <me>.
- SubRelation(index: number): Expr_GeneralRelation
Returns the relation denoted by <index> in <me>. An exception is raised if <index> is out of range.
Parameters (1)index
- IsSatisfied(): boolean
Returns the current status of the relation.
Returns a GeneralRelation after replacement of NamedUnknowns by an associated expression, and after values computation.
- Simplify(): void
Replaces NamedUnknowns by associated expressions, and computes values in <me>.
Returns a copy of <me> having the same unknowns and functions.
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <me> contains <exp>.
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me>.
Parameters (2)var_with_
returns a string representing <me> in a readable way.
Expr_Tangent
Constructors(1)
Creates the tangent of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_Tanh
Constructors(1)
Creates the hyperbolic tangent of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(8)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_UnaryExpression
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns the operand used.
- SetOperand(exp: Expr_GeneralExpression): void
Sets the operand used Raises InvalidOperand if <exp> contains <me>.
Parameters (1)exp
- NbSubExpressions(): number
Returns the number of sub-expressions contained in <me> ( >= 0).
- SubExpression(I: number): Expr_GeneralExpression
Returns the -th sub-expression of <me>. Raises OutOfRange if > NbSubExpressions(me).
Parameters (1)I
- ContainsUnknowns(): boolean
Does <me> contains NamedUnknown ?
- Contains(exp: Expr_GeneralExpression): boolean
Tests if <exp> is contained in <me>.
Parameters (1)exp
- Replace(var_: Expr_NamedUnknown, with_: Expr_GeneralExpression): void
Replaces all occurrences of with <with> in <me> Raises InvalidOperand if <with> contains <me>.
Parameters (2)var_with_
Returns a GeneralExpression after replacement of NamedUnknowns by an associated expression, and after values computation.
Expr_UnaryFunction
Defines the use of an unary function in an expression with a given argument.
Constructors(1)
Creates me as <func>(<exp>). Raises exception if <func> is not unary.
Parameters (2)funcexp
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns the function defining <me>.
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
returns the derivative on <X> unknown of <me>.
Parameters (1)X
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_UnaryMinus
Constructors(1)
Create the unary minus of <exp>.
Parameters (1)exp
Static methods(2)
- get_type_name(): string
Instance methods(9)
Returns a GeneralExpression after a simplification of the arguments of <me>.
Returns a copy of <me> having the same unknowns and functions.
- IsIdentical(Other: Expr_GeneralExpression): boolean
Tests if <me> and <Other> define the same expression. This method does not include any simplification before testing.
Parameters (1)Other
- IsLinear(): boolean
Tests if <me> is linear on every NamedUnknown it contains.
Returns the derivative on <X> unknown of <me>.
Parameters (1)X
- NDerivative(X: Expr_NamedUnknown, N: number): Expr_GeneralExpression
Returns the <N>-th derivative on <X> unknown of <me>. Raises OutOfRange if <N> <= 0.
Parameters (2)XN
- Evaluate(vars: NCollection_Array1_handle_Expr_NamedUnknown, vals: NCollection_Array1_double): number
Returns the value of <me> (as a Real) by replacement of <vars> by <vals>. Raises NotEvaluable if <me> contains NamedUnknown not in <vars> or NumericError if result cannot be computed.
Parameters (2)varsvals
returns a string representing <me> in a readable way.
Expr_UnknownIterator
Describes an iterator on NamedUnknowns contained in any GeneralExpression.
Constructors(1)
- Parameters (1)
exp