Handles a sum, function of multiple arguments. More...

#include <operations.h>

Inheritance diagram for csl::Sum:

Public Member Functions
	Sum ()
	Default constructor. Initializes argument to an empty std::vector.

	Sum (const csl::vector_expr &operands, bool explicitSum=false)
	Initializes argument to operands (copy each element) More...

	Sum (const Expr &leftOperand, const Expr &rightOperand, bool explicitSum=false)
	Creates the sum of & leftOperand and rightOperand. More...

csl::Type	getType () const override
	Gives the type of a Sum object. More...

virtual bool	isIndexed () const override

Expr	getNumericalFactor () const override

int	getOrderOf (Expr_info expr) const override

std::optional< Expr >	getTerm () const override

csl::vector_expr	getFactors () const override
	Returns all the possible factors. More...

std::optional< Expr >	getRealPart () const override
	Evaluates the real part of the Abstract and returns it. More...

Expr	getImaginaryPart () const override
	Evaluates the imaginary part of the Abstract and returns it. More...

std::optional< Expr >	getComplexModulus () const override
	Evaluates the modulus in the complex plane of the Abstract and returns it. More...

std::optional< Expr >	getComplexArgument () const override
	Evaluates the argument in the complex plane of the Abstract and returns it. More...

void	insert (const Expr &expr, bool explicitSum=false) override
	Inserts an expression in a sum or a product. More...

void	print (int mode=0, std::ostream &out=std::cout, bool lib=false) const override
	Displays the abstract in standard output. More...

void	printCode (int mode=0, std::ostream &out=std::cout) const override

std::string	printLaTeX (int mode=0) const override
	Creates a LaTeX output for the Abstract. More...

long double	evaluateScalar () const override
	Return the sum of all the arguments. More...

std::optional< Expr >	evaluate (csl::eval::mode user_mode=csl::eval::base) const override
	Evaluates the Abstract. More...

unique_Expr	copy_unique () const override

Expr	deepCopy () const override

Expr	refresh () const override

Expr	deepRefresh () const override

virtual bool	mergeTerms ()
	Merge identical terms. More...

void	orderTerms ()

std::optional< Expr >	derive (Expr_info expr) const override
	Derives the sum. More...

std::optional< Expr >	factor (bool full=false) const override
	Factors the expr if common factors are found. More...

std::optional< Expr >	factor (Expr_info expr, bool full=false) const override
	Factors the expr by expr if it is a common factor. More...

std::optional< Expr >	collect (std::vector< Expr > const &factors, bool full) const override
	Collects terms in sum according to some factors given by the user. More...

bool	askTerm (Expr_info term, bool exact=false) const override
	Check if expr can factor *this. More...

Expr	suppressTerm (Expr_info term) const override
	Remove a factor from an expr, that must have been determined before. More...

int	getParity (Expr_info t_variable) const override
	Returns the parity property of the expression with respect to t_variable. More...

bool	operator== (Expr_info expr) const override
	Compares the Abstract with another. More...

csl::vector_expr	getAlternateForms () const override
	Calculates and returns all possible alternate forms of the expression in terms of simplifications. For example 1-sin^2(x) is one of the alternate forms of cos^2(x). More...

bool	operator< (const Abstract *expr) const override

Public Member Functions inherited from csl::AbstractMultiFunc
	AbstractMultiFunc ()
	Default Constructor, initializes the std::vector argument empty.

csl::Type	getType () const override
	Gives the type of Abstract. More...

virtual csl::PrimaryType	getPrimaryType () const override
	Gives the primary type of an AbstractMultiFunc. More...

bool	getCommutable () const override
	Tells if the AbstractMultiFunc is commutable. More...

std::vector< csl::Parent >	getSubSymbols () const override

int	getNArgs (int axis=0) const override
	Returns the number of arguments of the AbstractMultiFunc. More...

const csl::vector_expr &	getVectorArgument () const override
	Returns the std::vector argument directly. More...

Expr const &	getArgument (int iArg=0) const override
	Returns one particular argument. More...

Expr &	getArgument (int iArg=0) override

std::optional< Expr >	findSubExpression (Expr_info subExpression, const Expr &newExpression) const override
	Searches a sub-expression and replaces it. More...

size_t	size () const override

bool	empty () const override

csl::vector_expr::iterator	begin () override

csl::vector_expr::iterator	end () override

csl::vector_expr::const_iterator	begin () const override

csl::vector_expr::const_iterator	end () const override

void	setArgument (const Expr &t_argument, int iArg=0) override
	Replaces one particular argument. More...

void	setVectorArgument (const csl::vector_expr &t_argument) override
	Replaced the entire std::vector of argument. More...

bool	isReal () const override

bool	isPurelyImaginary () const override

std::optional< Expr >	getRealPart () const override
	Evaluates the real part of the Abstract and returns it. More...

Expr	getImaginaryPart () const override
	Evaluates the imaginary part of the Abstract and returns it. More...

std::optional< Expr >	getComplexModulus () const override
	Evaluates the modulus in the complex plane of the Abstract and returns it. More...

std::optional< Expr >	getComplexArgument () const override
	Evaluates the argument in the complex plane of the Abstract and returns it. More...

std::optional< Expr >	getComplexConjugate () const override
	Calculates and returns the complex conjugate of the expression. More...

virtual std::optional< Expr >	replaceIndex (const Index &indexToReplace, const Index &newIndex, bool refresh=true) const override
	For indicial expressions, this function searches indexToContract and replaces it with newIndex. More...

virtual std::optional< Expr >	replaceIndices (std::vector< csl::Index > const &oldIndices, std::vector< csl::Index > const &newIndices, bool refresh=true, bool flipped=false) const override

Tensor	getPoint () const override

virtual std::optional< Expr >	expand (bool full=false, bool inPlace=false) const override
	Develops the Abstract. More...

virtual std::optional< Expr >	expand_if (std::function< bool(Expr const &)> const &f, bool full=false, bool inPlace=false) const override
	Develops the Abstract. More...

bool	dependsOn (Expr_info expr) const override
	Check recursively if the expression depends on expr. More...

bool	dependsOn (const AbstractParent *parent) const override

bool	dependsExplicitlyOn (Expr_info expr) const override
	Check recursively if expr is present in the expression. More...

bool	dependsExplicitlyOn (Parent_info expr) const override

bool	commutesWith (Expr_info expr, int sign=-1) const override
	Tells if the object commutes with expr. More...

int	isPolynomial (Expr_info expr) const override
	Determines if the expression is a mononomial term in expr, i.e. a term of the form C*expr^n with C independent of expr, n integer. More...

bool	operator< (Expr_info other) const override
	Compares the simplicity of the expression to another. More...

Expr const &	operator[] (int i) const override
	Access operator for multi-argument expressions, equivalent to the function getArgument(). More...

Expr &	operator[] (int i) override
	Access operator for multi-argument expressions, returns a reference so this function is not const. More...

Public Member Functions inherited from csl::Abstract
	Abstract ()
	Default Constructor. More...

virtual	~Abstract ()
	Destructor.

Expr	self ()

virtual void	printProp (std::ostream &fout=std::cout) const

void	printExplicit (int mode=0) const
	Displays explicitely the expression, with types of each component. This function is only used for debug. More...

virtual LibDependency	getLibDependency () const

virtual size_t	memoryOverhead () const

virtual std::string const &	getName () const
	Returns the Abstract's name. More...

virtual std::string const &	getLatexName () const

virtual bool	getElementary () const

virtual bool	getAllDependencies () const

virtual int	getDim () const
	Gives the dimension of the object. More...

virtual bool	isBuildingBlock () const
	Tells if the expression is a Building Block or not. More...

virtual bool	isArbitrary () const

virtual const std::vector< Equation * > &	getProperties () const

virtual bool	isComplexConjugate () const

virtual bool	isHermitianConjugate () const

virtual csl::ComplexProperty	getComplexProperty () const

virtual void	setComplexProperty (csl::ComplexProperty prop)

virtual void	setConjugated (bool t_conjugated)

virtual bool	isInteger () const
	Tells if the expression is an integer. Either an Integer object directly, or a Float that has an integer value. More...

virtual bool	getValued () const
	Tells if the expression is valued, i.e. is a function of numbers and valued literals (a Variable or Constant is not valued by default). More...

virtual long double	getValue () const
	Returns the value of the expression, if it has one explicitely. In particular, it will work only on Numbers and valued Literals, not on functions. More...

virtual long double	getDeltaPlus () const

virtual long double	getDeltaMinus () const

virtual long long int	getNum () const

virtual long long int	getDenom () const

virtual Expr const &	getArgument (const std::vector< int > &indices) const
	Allows to get specific arguments of expressions in multiple dimensions, by giving the indices in each dimension. More...

virtual Expr &	getArgument (const std::vector< int > &indices)

virtual Expr	getVariable () const
	Accessor to the variable that defines certain types of expressions. More...

virtual int	getOrder () const
	Accessor to the order (integer) that defines certain types of expressions. More...

virtual int	getSign () const

virtual bool	isAnOperator () const
	Tells if the expression is an operator (like a derivetive operator). More...

virtual bool	isEmpty () const
	Tells for a Derivative or an Integral if the argument is empty i.e. if the object must apply on the next argument encountered on the right. More...

virtual bool	operatorAppliesOn (Expr_info expr) const

virtual Expr	getOperand () const
	Returns the operand of an Operator. More...

virtual std::vector< int >	getShape () const
	Accessor to the shape of the tensor in the form of a std::vector of integers. More...

virtual Expr	getInfBoundary () const

virtual Expr	getSupBoundary () const

virtual void	setSupBoundary (Expr const &t_inf)

virtual void	setInfBoundary (Expr const &t_inf)

virtual int	getNIndices () const

virtual Index	getIndex (int i=0) const

virtual void	resetIndexStructure ()

virtual IndexStructure	getIndexStructure () const

IndexStructure	getIndexStructure (csl::Space const *space) const

virtual const IndexStructure &	getIndexStructureView () const

virtual IndexStructure &	getIndexStructureView ()

virtual IndexStructure	getFreeIndexStructure () const

virtual Parent	getParent () const
	For indicial expressions this function returns a pointer to the parent object of type TensorParent (not an expression). More...

virtual Parent_info	getParent_info () const

virtual int	getNContractedPairs () const
	Returns the number of contracted pairs of indices in an Indicial expression. More...

virtual csl::vector_expr	getPermutations (bool optimize=true) const
	Returns a std::vector of all possible permutations of an Indicial expression. The possible permutations are determined from the posible symmetries and anti-symmetries of the object. More...

virtual std::set< std::pair< int, int > >	getContractedPair () const

Expr	copy () const

virtual void	setName (const std::string &t_name)
	Change the name of the abstract. More...

virtual void	setCommutable (bool t_commutable)
	Allows the abstract to commute or not. More...

virtual void	addProperty (Equation *property)
	Adds a property to the object. More...

virtual void	removeProperty (Equation *property)
	Removes a property to the object. More...

virtual void	setValue (long double t_value)
	Sets the value if there is one (for Numerical and Literal valued).

virtual void	setValue (Expr const &t_value)

virtual void	setElementary (bool t_elementary)

virtual void	setAllDependencies (bool t_allDependencies)

virtual void	addDependency (Expr const &expr)

virtual void	removeDependency (Expr const &expr)

virtual void	setArgument (const Expr &expr, const std::vector< int > &indices)
	Sets the argument at position {i,j,...} for multi-dimensions expressions. More...

virtual void	setEmpty (bool t_empty)

virtual void	setOperand (const Expr &operand)
	Sets the operand of an operator. More...

virtual void	setOperandPrivate (const Expr &operand, bool leaveEmpty)
	Sets the operand of an operator. More...

virtual void	setVariable (Expr const &t_variable)

virtual void	setParent (const Parent &t_parent)

virtual std::optional< Expr >	replaceIndices (std::vector< Index > const &indexToReplace, std::vector< Index > const &newIndex, bool refresh=true, bool flipped=false) const

virtual void	replaceIndexInPlace (Index const &oldIndex, Index const &newIndex)

std::optional< Expr >	contractIndex (const Index &index) const

csl::vector_expr	breakSpace (const Space brokenSpace, const std::vector< const Space > &newSpace) const

virtual csl::vector_expr	breakSpace (const Space brokenSpace, const std::vector< const Space > &newSpace, const std::vector< std::string > &indexNames) const

virtual void	setIndexStructure (const IndexStructure &t_index)
	Replaces the index structure of the object, that must be an Indicial expression. More...

virtual void	setPoint (const Tensor &t_point)

virtual void	setFullySymmetric ()
	Sets an Indicial object fully symmetric. Allows to set quickly a frequent property of tensors. This function then erases all properties of symmetry / antisymmetry and sets fullySymmetric to True.

virtual void	setFullyAntiSymmetric ()
	Sets an Indicial object fully anti-symmetric. Allows to set quickly a frequent property of tensors. This function then erases all properties * of symmetry / antisymmetry and sets fullyAntiSymmetric to True.

virtual void	addSymmetry (int i1, int i2)
	Add a symmetry between the i1^{th} and the i2^{th} indices. If those indices are anti-symmetric, an error is thrown. More...

virtual void	addAntiSymmetry (int i1, int i2)
	Add an anti-symmetry between the i1^{th} and the i2^{th} indices. If those indices are symmetric, an error is thrown. More...

virtual int	permut (int i1, int i2)
	Tries to permut indices at place i1 and i2. If those two indices have a symmetry property, indices are swaped and the symmetry is returned. Else the fnuction does nothing and returns 0. More...

virtual int	getNFactor () const

virtual void	getExponents (std::vector< Expr > const &factors, std::vector< Expr > &exponents) const
	Fills in a vector the exponents corresponding to some factors for the expression. More...

virtual bool	checkIndexStructure (const std::vector< Index > &t_index) const
	Checks the compatibility of the index structure of an Indicial expression with another. In a sum, two terms must have exaclty the same index structure. More...

virtual bool	checkIndexStructure (const std::initializer_list< Index > &index) const
	Checks the compatibility of the index structure of an Indicial expression with another. In a sum, two terms must have exaclty the same index structure. More...

virtual bool	compareWithDummy (Expr_info expr, std::map< Index, Index > &constraints, bool keepAllCosntraints=false) const
	Comparison disregarding name of dummy indices, i.e. the two expressions * are equals even if dummy indices have not the same names in this and expr. More...

bool	compareWithDummy (Expr_info expr, bool keepAllCosntraints=false) const

virtual bool	dependsOn (Parent_info parent) const

virtual bool	matchShape (Expr_info expr, bool exact=false) const
	In the case of a vectorial-type expression, this function checks if the shape of expr matches itself. More...

virtual bool	hasContractionProperty (Expr_info B) const
	Tells (for an Indicial type) if there is a special contraction property with B. More...

virtual bool	hasChainContractionProperty () const

virtual std::vector< ContractionChain >	getContractionProperties () const

virtual Expr	contraction (Expr_info B) const
	Applies a special contraction of indices. Before calling this function we must check that there is indeed a contraction by calling the function hasContractionProperty(). More...

virtual Expr	contraction (const csl::vector_expr &chain) const

virtual std::optional< Expr >	suppressExponent (Expr const &factor, Expr const &exponent) const
	Returns the expression where the factor factor^exponent has been suppressed. More...

virtual Expr &	applySelfStructureOn (Expr &expr) const

virtual std::optional< Expr >	getTransposed (const Space *space, bool applyProp=true) const

virtual std::optional< Expr >	getTransposed (const std::vector< const Space *> &spaces, bool applyProp=true) const

virtual std::optional< Expr >	getHermitianConjugate (const Space *space) const

virtual std::optional< Expr >	getHermitianConjugate (const std::vector< const Space *> &spaces) const

virtual std::optional< Expr >	getPolynomialTerm (Expr_info t_variable, int order) const
	Calculates and returns the polynomial term corresponding to this with the variable t_variable* at order order. In particular, this function assumes that the checks have already been made with the function isPolynomial(). More...

virtual Expr	applyOperator (const Expr &operand, bool leaveEmpty=false) const
	Apply the operator on an operand, iif the expression is an operator. More...

virtual Expr	addition_own (const Expr &expr) const
	Contains implementation of special addition for Numerical- and Vectorial-types. More...

virtual Expr	multiplication_own (const Expr &expr, bool side=1) const
	Contains implementation of special multiplication for Numerical- and Vectorial-types. More...

virtual Expr	division_own (const Expr &expr) const
	Contains implementation of special division for Numerical- and Polynomial-types. For polynomial, the euclidean division of two polynomials is implemented. More...

virtual Expr	exponentiation_own (const Expr &expr) const
	Contains implementation of special exponentiation for Numerical- and Vectorial-types. More...

virtual Expr	getRegularExpression () const
	Returns a regular expression from the polynomial, that is a sum where the different powers of the variable appear explicitely. More...

virtual Expr	tensordot (const Expr &expr) const
	Returns the tensordot of two Vectorial expressions. More...

virtual Expr	dot (const Expr &expr) const
	Returns the dot product of two Vectorial expressions. More...

virtual Expr	getSum () const
	Calculates and returns the sum of all elements in the Vectorial object. More...

virtual Expr	getProduct () const
	Calculates and returns the product of all elements in the Vectorial object. More...

virtual Expr	getVectorialModulus () const
	Returns the Vectorial modulus of the Vectorial object, that is defined here as the squared root of the sum of element squared. Example: {A_{11}^2+A_{12}^2+}. More...

virtual Expr	getSubVectorial (int iExcept) const
	Allows to pick a part of a Vectorial expression, excluding the iExcept^{th} element. More...

virtual Expr	getSubVectorial (int iExcept, int jExcept) const
	Allows to pick a part of a Vectorial expression, excluding the [iExcept^{th},jExcept^{th}] element (useful for matrices). More...

virtual Expr	getSubVectorial (const std::vector< int > &exceptions) const
	Allows to pick a part of a Vectorial expression, excluding the iExcept^{th} element. More...

virtual Expr	getSubVectorial (const std::vector< std::vector< int >> &keepIndices) const

virtual Expr	getSubVectorial (std::vector< std::vector< int >>::const_iterator begin, std::vector< std::vector< int >>::const_iterator end) const

virtual Expr	determinant () const
	Returns the determinant of the object if it corresponds to a square matrix (or a scalar), 0 else. More...

virtual Expr	trace () const

virtual Expr	trace (int axis1, int axis2) const
	Calculates the trace over the axis axis1 and axis2 of a tensor. axis1 and axis2 can be the same, in which case the trace just corresponds to the sum over this particular axis. More...

virtual Expr	transpose () const
	Calculates and returns the transpose of a 2D matrix. More...

virtual Expr	hermitian () const

virtual Expr	symmetrise () const
	Calculates and returns the symmetrization of a 2D matrix. More...

virtual Expr	antisymmetrise () const
	Calculates and returns the anti-symmetrization of a 2D matrix. More...

virtual Expr	inverseMatrix () const
	Calculates and returns the inverse of a 2D square matrix. The applied method is: A^{-1} = 1/det(A)*Com(A)^T. More...

virtual Expr	getCanonicalPermutation () const

virtual Expr	applyDiracDelta (const Expr &, const Expr &) const

virtual void	operator= (double t_value)
	Equivalent to the setValue() function. More...

virtual bool	operator== (int t_value) const

virtual bool	operator== (double t_value) const

virtual bool	operator!= (int t_value) const

virtual bool	operator!= (double t_value) const

int	testDummy (Expr_info expr) const

bool	operator== (const Expr_c &expr) const

bool	operator== (const Expr &expr) const

bool	operator== (const Abstract &other) const

bool	operator!= (Expr_info expr) const

bool	operator!= (const Expr_c &expr) const
	Compares the Abstract with another. More...

bool	operator!= (const Expr &expr) const

bool	operator!= (const Abstract &other) const

bool	operator< (const Expr_c &expr) const
	Compares the simplicity of the expression to another. More...

bool	operator> (Expr_info expr) const
	Compares the simplicity of the expression to another. More...

bool	operator> (const Expr_c &expr) const

bool	operator<= (Expr_info expr) const

bool	operator>= (Expr_info expr) const
	Compares the simplicity of the expression to another. More...

bool	operator<= (const Expr_c &expr) const
	Compares the simplicity of the expression to another. More...

bool	operator>= (const Expr_c &expr) const

Protected Member Functions
virtual void	gatherFactors (csl::vector_expr &factors, csl::vector_expr &arg, bool full) const

void	clearRedundantFactors (csl::vector_expr &factors) const

Additional Inherited Members
Static Public Member Functions inherited from csl::Abstract
static std::string	regularName (std::string const &name)

static std::string	regularName (std::string_view name)

static std::string	regularLiteral (std::string const &name)

static std::string	regularLiteral (std::string_view name)

Protected Attributes inherited from csl::AbstractMultiFunc
csl::vector_expr	argument
	std::vector containing the arguments.

Detailed Description

Handles a sum, function of multiple arguments.

Constructor & Destructor Documentation

◆ Sum() [1/2]

csl::Sum::Sum	(	const csl::vector_expr &	operands,
		bool	explicitSum = `false`
	)

Initializes argument to operands (copy each element)

Parameters

operands Operands of the sum, copied in the object.

◆ Sum() [2/2]

csl::Sum::Sum	(	const Expr &	leftOperand,
		const Expr &	rightOperand,
		bool	explicitSum = `false`
	)

Creates the sum of & leftOperand and rightOperand.

Parameters

leftOperand	Left operand.
rightOperand	Right operand.

Member Function Documentation

◆ askTerm()

bool csl::Sum::askTerm	(	Expr_info	expr,
		bool	exact = `false`
	)		const

overridevirtual

Check if expr can factor *this.

In almost every case this corresponds just to the comparison ** *this == expr**. For Prod, Pow, Fraction types (all that are multiplicative) we must check if the factor hides in a product.

Parameters

expr	Factor to search in the expression.

Returns: True if expr is a possible factor.; False else.

Reimplemented from csl::Abstract.

◆ collect()

std::optional< Expr > csl::Sum::collect	(	std::vector< Expr > const &	factors,
		bool	full
	)		const

overridevirtual

Collects terms in sum according to some factors given by the user.

This function allows the factor with some specific scalar variables. For example, $ ax + ay + by $ can be factored in two ways. Either with $ (a, b) $ which gives $ a(x+y) + by $ ; or with $ (x, y) $ which gives $ ax + (a+b)y $ . With the collect function it is possible to choose precisely the set of variables that will be factored to express results in a standard way.

Parameters

factors	Factors to search in the expression.
full	Boolean (default = false) that tells if the collection must be recursive (full expression depth).

Returns: The collected expression if modifications have been done.; std::nullopt else.

Note: This function will probably replace the factor() function in the future.; For now, the collect function does not support factorization by indicial tensors, whereas factor() does.

Reimplemented from csl::AbstractMultiFunc.

◆ derive()

optional< Expr > csl::Sum::derive ( Expr_info expr ) const

overridevirtual

Derives the sum.

Parameters

expr	Argument of the derivation.

Returns: The sum of the derivatives of the arguments

Reimplemented from csl::Abstract.

◆ evaluate()

optional< Expr > csl::Sum::evaluate ( csl::eval::mode user_mode = csl::eval::base ) const

overridevirtual

Evaluates the Abstract.

Replaces all variables by their value and evaluating. This function must be used instead of evaluateScalar() when treating not only real scalars.* In particular (x=2, y=3) x+iy evaluates to 3+ 3i whereas evaluateScalar() would return 3.

Returns: The abstract result of the evaluation.

Implements csl::Abstract.

◆ evaluateScalar()

long double csl::Sum::evaluateScalar ( ) const

overridevirtual

Return the sum of all the arguments.

Returns: The sum of the scalar evaluation of all the arguments.

Note: For this function to be justified, all the arguments must be scalar and real.

Reimplemented from csl::Abstract.

◆ factor() [1/2]

optional< Expr > csl::Sum::factor ( bool full = false ) const

overridevirtual

Factors the expr if common factors are found.

Parameters

full	If true factors recursively all the arguments.

Reimplemented from csl::AbstractMultiFunc.

◆ factor() [2/2]

optional< Expr > csl::Sum::factor	(	Expr_info	expr,
		bool	full = `false`
	)		const

overridevirtual

Factors the expr by expr if it is a common factor.

Parameters

expr	Factor.
full	If true factors recursively all the arguments.

Reimplemented from csl::AbstractMultiFunc.

◆ getAlternateForms()

csl::vector_expr csl::Sum::getAlternateForms ( ) const

overridevirtual

Calculates and returns all possible alternate forms of the expression in terms of simplifications. For example 1-sin^2(x) is one of the alternate forms of cos^2(x).

Those alternate forms are then compared in terms of simplicity, this allows automatic simplification. Alternates are tried to simplify, and the bests are chosed. More details and algorithms in file alternateForms.cpp.

Returns: A std::vector containing the alternate forms of the expression.

Reimplemented from csl::Abstract.

◆ getComplexArgument()

optional< Expr > csl::Sum::getComplexArgument ( ) const

overridevirtual

Evaluates the argument in the complex plane of the Abstract and returns it.

Returns: The argument part of the Abstract.

Reimplemented from csl::Abstract.

◆ getComplexModulus()

optional< Expr > csl::Sum::getComplexModulus ( ) const

overridevirtual

Evaluates the modulus in the complex plane of the Abstract and returns it.

Returns: The modulus part of the Abstract.

Reimplemented from csl::Abstract.

◆ getFactors()

csl::vector_expr csl::Sum::getFactors ( ) const

overridevirtual

Returns all the possible factors.

Returns: The concatenation of all possible factors for the arguments.

Reimplemented from csl::Abstract.

◆ getImaginaryPart()

Expr csl::Sum::getImaginaryPart ( ) const

overridevirtual

Evaluates the imaginary part of the Abstract and returns it.

Returns: The imaginary part of the Abstract.

Reimplemented from csl::Abstract.

◆ getNumericalFactor()

Expr csl::Sum::getNumericalFactor ( ) const

overridevirtual

Returns: The numerical factor of the sum.

Reimplemented from csl::Abstract.

◆ getParity()

int csl::Sum::getParity ( Expr_info t_variable ) const

overridevirtual

Returns the parity property of the expression with respect to t_variable.

Parameters

t_variable.

Returns: 1 if the expression is even in t_variable.; -1 if the expression is odd in t_variable.; 0 else.

Reimplemented from csl::Abstract.

◆ getRealPart()

optional< Expr > csl::Sum::getRealPart ( ) const

overridevirtual

Evaluates the real part of the Abstract and returns it.

Returns: The real part of the Abstract.

Reimplemented from csl::Abstract.

◆ getTerm()

optional< Expr > csl::Sum::getTerm ( ) const

overridevirtual

Returns: The sum divided by its factor.

Reimplemented from csl::Abstract.

◆ getType()

csl::Type csl::Sum::getType ( ) const

inlineoverridevirtual

Gives the type of a Sum object.

Returns: 10

Implements csl::Abstract.

◆ insert()

void csl::Sum::insert	(	const Expr &	expr,
		bool	side = `false`
	)

overridevirtual

Inserts an expression in a sum or a product.

Allows to insert an element in a sum or product without comparing all existing terms. This saves time when inserting element by element. The side parameter allows to insert to the left (side = 0) or to the right (side = 1) in products (useful when considering non commutating expressions.

Parameters

expr	Expression to insert.
side	Side of insertion for Prod expressions.

Reimplemented from csl::Abstract.

◆ isIndexed()

virtual bool csl::Sum::isIndexed ( ) const

inlineoverridevirtual

Returns: True if the expression is indexed.; False else.

Reimplemented from csl::AbstractMultiFunc.

Reimplemented in csl::ISum.

◆ mergeTerms()

bool csl::Sum::mergeTerms ( )

virtual

Merge identical terms.

When identical terms (identical to a numerical factor) appear this function merge them in the same term. Example: x+y+2*x -> 3*x+y.

Returns: True if terms have been merged.; False else.

◆ operator==()

bool csl::Sum::operator== ( Expr_info expr ) const

overridevirtual

Compares the Abstract with another.

Here if two Abstracts have the same name, the function will return true even if they are not mathematically equal. So beware not to name different things the same way.

Parameters

expr	Abstract to compare.

Returns: True if the two Abstracts are the same (or have the same name).; False else.

Implements csl::Abstract.

◆ print()

void csl::Sum::print	(	int	mode = `0`,
		std::ostream &	out = `std::cout`,
		bool	lib = `false`
	)		const

overridevirtual

Displays the abstract in standard output.

Parameters

mode	Tells if the Abstract is printed alone (default) or in another expr.

Implements csl::Abstract.

◆ printLaTeX()

string csl::Sum::printLaTeX ( int mode = 0 ) const

overridevirtual

Creates a LaTeX output for the Abstract.

Parameters

mode	Tells if the Abstract is printed alone (default) or in another expr.

Returns: The string corresponding to the LaTeX output.

Reimplemented from csl::Abstract.

◆ suppressTerm()

Expr csl::Sum::suppressTerm ( Expr_info expr ) const

overridevirtual

Remove a factor from an expr, that must have been determined before.

Parameters

factor Expression to remove

Returns: The expr in which factor has been removed

Reimplemented from csl::Abstract.

The documentation for this class was generated from the following files:

include/operations.h
src/alternateForms.cpp
src/operations.cpp
src/simplification.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sum() [1/2]

◆ Sum() [2/2]

Member Function Documentation

◆ askTerm()

◆ collect()

◆ derive()

◆ evaluate()

◆ evaluateScalar()

◆ factor() [1/2]

◆ factor() [2/2]

◆ getAlternateForms()

◆ getComplexArgument()

◆ getComplexModulus()

◆ getFactors()

◆ getImaginaryPart()

◆ getNumericalFactor()

◆ getParity()

◆ getRealPart()

◆ getTerm()

◆ getType()

◆ insert()

◆ isIndexed()

◆ mergeTerms()

◆ operator==()

◆ print()

◆ printLaTeX()

◆ suppressTerm()