#include <infinity.h>

Inheritance diagram for SymEngine::Infty:

Collaboration diagram for SymEngine::Infty:

Public Member Functions
void	accept (Visitor &v) const override

void	accept (EvalRealDoubleVisitorFinal &v) const override

	Infty (const RCP< const Number > &direction)
	Constructs Infty using the sign of `_direction`

	Infty (const Infty &inf)
	Copy Constructor.

bool	is_canonical (const RCP< const Number > &num) const
	Canonical when the direction is -1, 0 or 1. More...

hash_t	__hash__ () const override

bool	__eq__ (const Basic &o) const override

int	compare (const Basic &o) const override

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

bool	is_zero () const override

bool	is_one () const override

bool	is_minus_one () const override

bool	is_exact () const override

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

RCP< const Number >	get_direction () const

bool	is_unsigned_infinity () const

bool	is_positive_infinity () const

bool	is_negative_infinity () const

bool	is_positive () const override

bool	is_negative () const override

bool	is_complex () const override

RCP< const Basic >	conjugate () const override

RCP< const Number >	add (const Number &other) const override
	Addition.

RCP< const Number >	mul (const Number &other) const override
	Multiplication.

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

RCP< const Number >	pow (const Number &other) const override
	Power.

RCP< const Number >	rpow (const Number &other) const override

Public Member Functions inherited from SymEngine::Number
bool	is_exact_zero () const

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

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

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

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.

hash_t	hash () const

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

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

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

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

Static Public Member Functions
static RCP< const Infty >	from_direction (const RCP< const Number > &direction)

static RCP< const Infty >	from_int (const int val)
	Constructs Infty using sign of `val`

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

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_INFTY

Private Attributes
RCP< const Number >	_direction

Additional Inherited Members
Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

This class holds "infinity" It includes a direction (like -infinity).

Definition at line 20 of file infinity.h.

Member Function Documentation

◆ eq()

bool SymEngine::Infty::__eq__ ( const Basic & o ) const

overridevirtual

Equality comparator

Parameters

o	- Object to be compared with

Returns: whether the 2 objects are equal

Implements SymEngine::Basic.

Definition at line 58 of file infinity.cpp.

 {
     if (is_a<Infty>(o)) {
         const Infty &s = down_cast<const Infty &>(o);
         return eq(*_direction, *(s.get_direction()));
     }
  
     return false;
 }

◆ hash()

hash_t SymEngine::Infty::__hash__ ( ) const

overridevirtual

Returns: size of the hash

Implements SymEngine::Basic.

Definition at line 51 of file infinity.cpp.

 {
     hash_t seed = SYMENGINE_INFTY;
     hash_combine<Basic>(seed, *_direction);
     return seed;
 }

◆ compare()

int SymEngine::Infty::compare ( const Basic & o ) const

overridevirtual

Returns -1, 0, 1 for this < o, this == o, this > o. This method is used when you want to sort things like x+y+z into canonical order. This function assumes that o is the same type as this. Use __cmp__ if you want general comparison.

Implements SymEngine::Basic.

Definition at line 68 of file infinity.cpp.

 {
     SYMENGINE_ASSERT(is_a<Infty>(o))
     const Infty &s = down_cast<const Infty &>(o);
     return _direction->compare(*(s.get_direction()));
 }

◆ conjugate()

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

overridevirtual

Returns: the conjugate if the class is complex

Reimplemented from SymEngine::Number.

Definition at line 90 of file infinity.cpp.

 {
     if (is_positive_infinity() or is_negative_infinity()) {
         return infty(_direction);
     }
     return make_rcp<const Conjugate>(ComplexInf);
 }

◆ is_canonical()

bool SymEngine::Infty::is_canonical ( const RCP< const Number > & num ) const

Canonical when the direction is -1, 0 or 1.

Returns: true if canonical

Definition at line 40 of file infinity.cpp.

 {
     if (is_a<Complex>(*num) || is_a<ComplexDouble>(*num))
         throw NotImplementedError("Not implemented for all directions");
  
     if (num->is_one() || num->is_zero() || num->is_minus_one())
         return true;
  
     return false;
 }

◆ is_complex()

bool SymEngine::Infty::is_complex ( ) const

inlineoverridevirtual

Returns: true if a complex number

Implements SymEngine::Number.

Definition at line 95 of file infinity.h.

     {
         return is_unsigned_infinity();
     }

◆ is_exact()

bool SymEngine::Infty::is_exact ( ) const

inlineoverridevirtual

Returns: true if this number is an exact number

Reimplemented from SymEngine::Number.

Definition at line 69 of file infinity.h.

     {
         return false;
     }

◆ is_minus_one()

bool SymEngine::Infty::is_minus_one ( ) const

inlineoverridevirtual

Returns: true if -1

Implements SymEngine::Number.

Definition at line 63 of file infinity.h.

     {
         return false;
     }

◆ is_negative()

bool SymEngine::Infty::is_negative ( ) const

inlineoverridevirtual

Returns: true if negative

Implements SymEngine::Number.

Definition at line 90 of file infinity.h.

     {
         return is_negative_infinity();
     }

◆ is_one()

bool SymEngine::Infty::is_one ( ) const

inlineoverridevirtual

Returns: true if 1

Implements SymEngine::Number.

Definition at line 58 of file infinity.h.

     {
         return false;
     }

◆ is_positive()

bool SymEngine::Infty::is_positive ( ) const

inlineoverridevirtual

Returns: true if positive

Implements SymEngine::Number.

Definition at line 85 of file infinity.h.

     {
         return is_positive_infinity();
     }

◆ is_zero()

bool SymEngine::Infty::is_zero ( ) const

inlineoverridevirtual

Returns: true if 0

Implements SymEngine::Number.

Definition at line 53 of file infinity.h.

     {
         return false;
     }

Field Documentation

◆ type_code_id

const TypeID SymEngine::Infty::type_code_id = SYMENGINE_INFTY

static

Type_code_id shared by all instances

Definition at line 25 of file infinity.h.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ compare()

◆ conjugate()

◆ is_canonical()

◆ is_complex()

◆ is_exact()

◆ is_minus_one()

◆ is_negative()

◆ is_one()

◆ is_positive()

◆ is_zero()

Field Documentation

◆ type_code_id

◆ eq()

◆ hash()