Inheritance diagram for SymEngine::Number:

Collaboration diagram for SymEngine::Number:

Public Member Functions
virtual bool	is_zero () const =0

virtual bool	is_one () const =0

virtual bool	is_minus_one () const =0

virtual bool	is_negative () const =0

virtual bool	is_positive () const =0

virtual bool	is_complex () const =0

virtual RCP< const Basic >	conjugate () const

virtual bool	is_exact () const
	return true if the number is an exact representation

bool	is_exact_zero () const

virtual Evaluate &	get_eval () const
	Get `Evaluate` singleton to evaluate numerically.

virtual RCP< const Number >	add (const Number &other) const =0
	Addition.

virtual RCP< const Number >	sub (const Number &other) const
	Subtraction.

virtual RCP< const Number >	rsub (const Number &other) const

virtual RCP< const Number >	mul (const Number &other) const =0
	Multiplication.

virtual RCP< const Number >	div (const Number &other) const
	Division.

virtual RCP< const Number >	rdiv (const Number &other) const

virtual RCP< const Number >	pow (const Number &other) const =0
	Power.

virtual RCP< const Number >	rpow (const Number &other) const =0

vec_basic	get_args () const override
	Returns the list of arguments.

virtual bool	is_perfect_power (bool is_expected=false) const

virtual bool	nth_root (const Ptr< RCP< const Number >> &, unsigned long n) const

Public Member Functions inherited from SymEngine::Basic
TypeID	get_type_code () const

	Basic ()
	Constructor.

	Basic (const Basic &)=delete
	Delete the copy constructor and assignment.

Basic &	operator= (const Basic &)=delete
	Assignment operator in continuation with above.

	Basic (Basic &&)=delete
	Delete the move constructor and assignment.

Basic &	operator= (Basic &&)=delete
	Assignment operator in continuation with above.

virtual hash_t	__hash__ () const =0

hash_t	hash () const

virtual bool	__eq__ (const Basic &o) const =0
	Test equality. More...

bool	__neq__ (const Basic &o) const
	true if `this` is not equal to `o`. More...

int	__cmp__ (const Basic &o) const
	Comparison operator.

virtual int	compare (const Basic &o) const =0

std::string	__str__ () const

std::string	dumps () const
	Returns a string of the instance serialized.

RCP< const Basic >	subs (const map_basic_basic &subs_dict) const
	Substitutes 'subs_dict' into 'self'.

RCP< const Basic >	xreplace (const map_basic_basic &subs_dict) const

virtual RCP< const Basic >	expand_as_exp () const
	expands the special function in terms of exp function

virtual void	accept (Visitor &v) const =0

virtual void	accept (EvalRealDoubleVisitorFinal &v) const =0

RCP< const Basic >	diff (const RCP< const Symbol > &x, bool cache=true) const

Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basic >	rcp_from_this ()
	Get RCP<T> pointer to self (it will cast the pointer to T)

RCP< const Basic >	rcp_from_this () const
	Get RCP<const T> pointer to self (it will cast the pointer to const T)

RCP< const T2 >	rcp_from_this_cast () const
	Get RCP<T2> pointer to self (it will cast the pointer to T2)

unsigned int	use_count () const

Additional Inherited Members
Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.

Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 18 of file number.h.

Member Function Documentation

◆ conjugate()

RCP< const Basic > SymEngine::Number::conjugate ( ) const

virtual

Returns: the conjugate if the class is complex

Reimplemented in SymEngine::NaN, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

Definition at line 8 of file number.cpp.

 {
     if (not is_complex()) {
         return this->rcp_from_this();
     }
     throw NotImplementedError("Not Implemented.");
 }

◆ is_complex()

virtual bool SymEngine::Number::is_complex ( ) const

pure virtual

Returns: true if a complex number

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

◆ is_exact_zero()

bool SymEngine::Number::is_exact_zero ( ) const

inline

Returns: true if the number is equal to 0 and not an approximation

Definition at line 42 of file number.h.

     {
         return is_exact() and is_zero();
     };

◆ is_minus_one()

virtual bool SymEngine::Number::is_minus_one ( ) const

pure virtual

Returns: true if -1

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

◆ is_negative()

virtual bool SymEngine::Number::is_negative ( ) const

pure virtual

Returns: true if negative

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

◆ is_one()

virtual bool SymEngine::Number::is_one ( ) const

pure virtual

Returns: true if 1

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

◆ is_positive()

virtual bool SymEngine::Number::is_positive ( ) const

pure virtual

Returns: true if positive

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

◆ is_zero()

virtual bool SymEngine::Number::is_zero ( ) const

pure virtual

Returns: true if 0

Implemented in SymEngine::SeriesBase< Poly, Coeff, Series >, SymEngine::SeriesBase< UExprDict, Expression, UnivariateSeries >, SymEngine::RealDouble, SymEngine::Rational, SymEngine::NaN, SymEngine::Integer, SymEngine::Infty, SymEngine::ComplexDouble, and SymEngine::Complex.

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

/home/runner/work/symengine/symengine/symengine/number.h
/home/runner/work/symengine/symengine/symengine/number.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ conjugate()

◆ is_complex()

◆ is_exact_zero()

◆ is_minus_one()

◆ is_negative()

◆ is_one()

◆ is_positive()

◆ is_zero()