#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.

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
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.

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

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 vec_basic	get_args () const =0
	Returns the list of arguments.

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

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.

Constructor & Destructor Documentation

◆ Infty() [1/2]

SymEngine::Infty::Infty ( const RCP< const Number > & direction )

Constructs Infty using the sign of _direction

Definition at line 14 of file infinity.cpp.

{
    SYMENGINE_ASSIGN_TYPEID()
    _direction = direction;
    SYMENGINE_ASSERT(is_canonical(_direction));
}

◆ Infty() [2/2]

SymEngine::Infty::Infty ( const Infty & inf )

Copy Constructor.

Definition at line 21 of file infinity.cpp.

{
    SYMENGINE_ASSIGN_TYPEID()
    _direction = inf.get_direction();
    SYMENGINE_ASSERT(is_canonical(_direction))
}

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;
}

◆ accept() [1/2]

void SymEngine::Infty::accept ( EvalRealDoubleVisitorFinal & v ) const

overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

void SymEngine::Infty::accept ( Visitor & v ) const

overridevirtual

Implements SymEngine::Basic.

◆ add()

RCP< const Number > SymEngine::Infty::add ( const Number & other ) const

overridevirtual

Addition.

Implements SymEngine::Number.

Definition at line 98 of file infinity.cpp.

{
    if (not is_a<Infty>(other))
        return rcp_from_this_cast<Number>();
 
    const Infty &s = down_cast<const Infty &>(other);
 
    if (not eq(*s.get_direction(), *_direction))
        return Nan;
    else if (is_unsigned_infinity())
        return Nan;
    else
        return rcp_from_this_cast<Number>();
}

◆ 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);
}

◆ div()

RCP< const Number > SymEngine::Infty::div ( const Number & other ) const

overridevirtual

Division.

Reimplemented from SymEngine::Number.

Definition at line 132 of file infinity.cpp.

{
    if (is_a<Infty>(other)) {
        return Nan;
    } else {
        if (other.is_positive())
            return rcp_from_this_cast<Number>();
        else if (other.is_zero())
            return infty(0);
        else
            return infty(this->_direction->mul(*minus_one));
    }
}

◆ from_direction()

RCP< const Infty > SymEngine::Infty::from_direction ( const RCP< const Number > & direction )

static

Definition at line 28 of file infinity.cpp.

{
    return make_rcp<Infty>(direction);
}

◆ from_int()

RCP< const Infty > SymEngine::Infty::from_int ( const int val )

static

Constructs Infty using sign of val

Definition at line 33 of file infinity.cpp.

{
    SYMENGINE_ASSERT(val >= -1 && val <= 1)
    return make_rcp<Infty>(integer(val));
}

◆ get_args()

vec_basic SymEngine::Infty::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 47 of file infinity.h.

    {
        return {_direction};
    }

◆ get_direction()

RCP< const Number > SymEngine::Infty::get_direction ( ) const

inline

Definition at line 76 of file infinity.h.

    {
        return _direction;
    }

◆ get_eval()

Evaluate & SymEngine::Infty::get_eval ( ) const

overridevirtual

Get Evaluate singleton to evaluate numerically.

Reimplemented from SymEngine::Number.

Definition at line 531 of file infinity.cpp.

{
    static EvaluateInfty evaluate_infty;
    return evaluate_infty;
}

◆ 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_negative_infinity()

bool SymEngine::Infty::is_negative_infinity ( ) const

Definition at line 85 of file infinity.cpp.

{
    return _direction->is_negative();
}

◆ 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_positive_infinity()

bool SymEngine::Infty::is_positive_infinity ( ) const

Definition at line 80 of file infinity.cpp.

{
    return _direction->is_positive();
}

◆ is_unsigned_infinity()

bool SymEngine::Infty::is_unsigned_infinity ( ) const

Definition at line 75 of file infinity.cpp.

{
    return _direction->is_zero();
}

◆ 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;
    }

◆ mul()

RCP< const Number > SymEngine::Infty::mul ( const Number & other ) const

overridevirtual

Multiplication.

Implements SymEngine::Number.

Definition at line 113 of file infinity.cpp.

{
    if (is_a<Complex>(other))
        throw NotImplementedError(
            "Multiplication with Complex not implemented");
 
    if (is_a<Infty>(other)) {
        const Infty &s = down_cast<const Infty &>(other);
        return make_rcp<const Infty>(this->_direction->mul(*(s._direction)));
    } else {
        if (other.is_positive())
            return rcp_from_this_cast<Number>();
        else if (other.is_negative())
            return make_rcp<const Infty>(this->_direction->mul(*minus_one));
        else
            return Nan;
    }
}

◆ pow()

RCP< const Number > SymEngine::Infty::pow ( const Number & other ) const

overridevirtual

Power.

Implements SymEngine::Number.

Definition at line 146 of file infinity.cpp.

{
    if (is_a<Infty>(other)) {
        if (is_positive_infinity()) {
            if (other.is_negative()) {
                return zero;
            } else if (other.is_positive()) {
                return rcp_from_this_cast<Number>();
            } else {
                return Nan;
            }
        } else if (is_negative_infinity()) {
            return Nan;
        } else {
            if (other.is_positive()) {
                return infty(0);
            } else if (other.is_negative()) {
                return zero;
            } else {
                return Nan;
            }
        }
    } else if (is_a<Complex>(other)) {
        throw NotImplementedError(
            "Raising to the Complex powers not yet implemented");
    } else {
        if (other.is_negative()) {
            return zero;
        } else if (other.is_zero()) {
            return one;
        } else {
            if (is_positive_infinity()) {
                return rcp_from_this_cast<Number>();
            } else if (is_negative_infinity()) {
                throw NotImplementedError("Raising Negative Infty to the "
                                          "Positive Real powers not yet "
                                          "implemented");
            } else {
                return infty(0);
            }
        }
    }
}

◆ rpow()

RCP< const Number > SymEngine::Infty::rpow ( const Number & other ) const

overridevirtual

Implements SymEngine::Number.

Definition at line 190 of file infinity.cpp.

{
    if (is_a_Complex(other)) {
        throw NotImplementedError(
            "Raising Complex powers to Infty not yet implemented");
    } else {
        if (other.is_negative()) {
            throw NotImplementedError("Raising Negative numbers to infinite "
                                      "powers not yet implemented");
        } else if (other.is_zero()) {
            throw SymEngineException("Indeterminate Expression: `0 ** +- "
                                     "unsigned Infty` encountered");
        } else {
            const Number &s = down_cast<const Number &>(other);
            if (s.is_one()) {
                return Nan;
            } else if (is_positive_infinity()) {
                if (s.sub(*one)->is_negative()) {
                    return zero;
                } else {
                    return rcp_from_this_cast<Number>();
                }
            } else if (is_negative_infinity()) {
                if (s.sub(*one)->is_negative()) {
                    return infty(0);
                } else {
                    return zero;
                }
            } else {
                throw SymEngineException("Indeterminate Expression: `Positive "
                                         "Real Number ** unsigned Infty` "
                                         "encountered");
            }
        }
    }
}

Field Documentation

◆ _direction

RCP<const Number> SymEngine::Infty::_direction

private

Definition at line 22 of file infinity.h.

◆ 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

Constructor & Destructor Documentation

◆ Infty() [1/2]

◆ Infty() [2/2]

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ accept() [1/2]

◆ accept() [2/2]

◆ add()

◆ compare()

◆ conjugate()

◆ div()

◆ from_direction()

◆ from_int()

◆ get_args()

◆ get_direction()

◆ get_eval()

◆ is_canonical()

◆ is_complex()

◆ is_exact()

◆ is_minus_one()

◆ is_negative()

◆ is_negative_infinity()

◆ is_one()

◆ is_positive()

◆ is_positive_infinity()

◆ is_unsigned_infinity()

◆ is_zero()

◆ mul()

◆ pow()

◆ rpow()

Field Documentation

◆ _direction

◆ type_code_id

◆ eq()

◆ hash()