RealDouble Class to hold double values. More...

#include <real_double.h>

Inheritance diagram for SymEngine::RealDouble:

Collaboration diagram for SymEngine::RealDouble:

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

void	accept (EvalRealDoubleVisitorFinal &v) const override

	RealDouble (double i)
	Constructor of RealDouble class.

hash_t	__hash__ () const override

bool	__eq__ (const Basic &o) const override

int	compare (const Basic &o) const override

bool	is_positive () const override

bool	is_negative () const override

double	as_double () const

bool	is_exact () const override

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

bool	is_zero () const override

bool	is_one () const override

bool	is_minus_one () const override

bool	is_complex () const override

RCP< const Number >	addreal (const Integer &other) const

RCP< const Number >	addreal (const Rational &other) const

RCP< const Number >	addreal (const Complex &other) const

RCP< const Number >	addreal (const RealDouble &other) const

RCP< const Number >	add (const Number &other) const override
	Converts the param `other` appropriately and then calls `addreal`

RCP< const Number >	subreal (const Integer &other) const

RCP< const Number >	subreal (const Rational &other) const

RCP< const Number >	subreal (const Complex &other) const

RCP< const Number >	subreal (const RealDouble &other) const

RCP< const Number >	sub (const Number &other) const override
	Converts the param `other` appropriately and then calls `subreal`

RCP< const Number >	rsubreal (const Integer &other) const

RCP< const Number >	rsubreal (const Rational &other) const

RCP< const Number >	rsubreal (const Complex &other) const

RCP< const Number >	rsub (const Number &other) const override
	Converts the param `other` appropriately and then calls `subreal`

RCP< const Number >	mulreal (const Integer &other) const

RCP< const Number >	mulreal (const Rational &other) const

RCP< const Number >	mulreal (const Complex &other) const

RCP< const Number >	mulreal (const RealDouble &other) const

RCP< const Number >	mul (const Number &other) const override
	Converts the param `other` appropriately and then calls `mulreal`

RCP< const Number >	divreal (const Integer &other) const

RCP< const Number >	divreal (const Rational &other) const

RCP< const Number >	divreal (const Complex &other) const

RCP< const Number >	divreal (const RealDouble &other) const

RCP< const Number >	div (const Number &other) const override
	Converts the param `other` appropriately and then calls `divreal`

RCP< const Number >	rdivreal (const Integer &other) const

RCP< const Number >	rdivreal (const Rational &other) const

RCP< const Number >	rdivreal (const Complex &other) const

RCP< const Number >	rdiv (const Number &other) const override
	Converts the param `other` appropriately and then calls `divreal`

RCP< const Number >	powreal (const Integer &other) const

RCP< const Number >	powreal (const Rational &other) const

RCP< const Number >	powreal (const Complex &other) const

RCP< const Number >	powreal (const RealDouble &other) const

RCP< const Number >	pow (const Number &other) const override
	Converts the param `other` appropriately and then calls `powreal`

RCP< const Number >	rpowreal (const Integer &other) const

RCP< const Number >	rpowreal (const Rational &other) const

RCP< const Number >	rpowreal (const Complex &other) const

RCP< const Number >	rpow (const Number &other) const override
	Converts the param `other` appropriately and then calls `powreal`

Public Member Functions inherited from SymEngine::Number
virtual RCP< const Basic >	conjugate () const

bool	is_exact_zero () 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

Data Fields
double	i

Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_REAL_DOUBLE

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.

Detailed Description

RealDouble Class to hold double values.

Definition at line 19 of file real_double.h.

Member Function Documentation

◆ eq()

bool SymEngine::RealDouble::__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 25 of file real_double.cpp.

 {
     if (is_a<RealDouble>(o)) {
         const RealDouble &s = down_cast<const RealDouble &>(o);
         return this->i == s.i;
     }
     return false;
 }

◆ hash()

hash_t SymEngine::RealDouble::__hash__ ( ) const

overridevirtual

Returns: size of the hash

Implements SymEngine::Basic.

Definition at line 18 of file real_double.cpp.

 {
     hash_t seed = SYMENGINE_REAL_DOUBLE;
     hash_combine<double>(seed, i);
     return seed;
 }

◆ addreal() [1/4]

RCP<const Number> SymEngine::RealDouble::addreal ( const Complex & other ) const

inline

Add RealDoubles

Parameters

other of type Complex

Definition at line 104 of file real_double.h.

     {
         return number(i
                       + std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_)));
     }

◆ addreal() [2/4]

RCP<const Number> SymEngine::RealDouble::addreal ( const Integer & other ) const

inline

Add RealDoubles

Parameters

other of type Integer

Definition at line 86 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i
                                           + mp_get_d(other.as_integer_class()));
     }

◆ addreal() [3/4]

RCP<const Number> SymEngine::RealDouble::addreal ( const Rational & other ) const

inline

Add RealDoubles

Parameters

other of type Rational

Definition at line 95 of file real_double.h.

     {
         return make_rcp<const RealDouble>(
             i + mp_get_d(other.as_rational_class()));
     }

◆ addreal() [4/4]

RCP<const Number> SymEngine::RealDouble::addreal ( const RealDouble & other ) const

inline

Add RealDoubles

Parameters

other of type RealDouble

Definition at line 114 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i + other.i);
     }

◆ as_double()

double SymEngine::RealDouble::as_double ( ) const

inline

Returns: self as a double

Definition at line 47 of file real_double.h.

     {
         return i;
     }

◆ compare()

int SymEngine::RealDouble::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 34 of file real_double.cpp.

 {
     SYMENGINE_ASSERT(is_a<RealDouble>(o))
     const RealDouble &s = down_cast<const RealDouble &>(o);
     if (i == s.i)
         return 0;
     return i < s.i ? -1 : 1;
 }

◆ divreal() [1/4]

RCP<const Number> SymEngine::RealDouble::divreal ( const Complex & other ) const

inline

Divide RealDoubles

Parameters

other of type Complex

Definition at line 305 of file real_double.h.

     {
         return number(i
                       / std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_)));
     }

◆ divreal() [2/4]

RCP<const Number> SymEngine::RealDouble::divreal ( const Integer & other ) const

inline

Divide RealDoubles

Parameters

other of type Integer

Definition at line 287 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i
                                           / mp_get_d(other.as_integer_class()));
     }

◆ divreal() [3/4]

RCP<const Number> SymEngine::RealDouble::divreal ( const Rational & other ) const

inline

Divide RealDoubles

Parameters

other of type Rational

Definition at line 296 of file real_double.h.

     {
         return make_rcp<const RealDouble>(
             i / mp_get_d(other.as_rational_class()));
     }

◆ divreal() [4/4]

RCP<const Number> SymEngine::RealDouble::divreal ( const RealDouble & other ) const

inline

Divide RealDoubles

Parameters

other of type RealDouble

Definition at line 315 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i / other.i);
     }

◆ is_complex()

bool SymEngine::RealDouble::is_complex ( ) const

inlineoverridevirtual

Returns: false

Implements SymEngine::Number.

Definition at line 78 of file real_double.h.

     {
         return false;
     }

◆ is_exact()

bool SymEngine::RealDouble::is_exact ( ) const

inlineoverridevirtual

Returns: true if this number is an exact number

Reimplemented from SymEngine::Number.

Definition at line 52 of file real_double.h.

     {
         return false;
     }

◆ is_minus_one()

bool SymEngine::RealDouble::is_minus_one ( ) const

inlineoverridevirtual

Returns: false

Implements SymEngine::Number.

Definition at line 72 of file real_double.h.

     {
         return false;
     }

◆ is_negative()

bool SymEngine::RealDouble::is_negative ( ) const

inlineoverridevirtual

Returns: true if negative

Implements SymEngine::Number.

Definition at line 42 of file real_double.h.

     {
         return i < 0;
     }

◆ is_one()

bool SymEngine::RealDouble::is_one ( ) const

inlineoverridevirtual

Returns: false

Implements SymEngine::Number.

Definition at line 66 of file real_double.h.

     {
         return false;
     }

◆ is_positive()

bool SymEngine::RealDouble::is_positive ( ) const

inlineoverridevirtual

Returns: true if positive

Implements SymEngine::Number.

Definition at line 37 of file real_double.h.

     {
         return i > 0;
     }

◆ is_zero()

bool SymEngine::RealDouble::is_zero ( ) const

inlineoverridevirtual

Returns: true when equals to 0

Implements SymEngine::Number.

Definition at line 60 of file real_double.h.

     {
         return this->i == 0.0;
     }

◆ mulreal() [1/4]

RCP<const Number> SymEngine::RealDouble::mulreal ( const Complex & other ) const

inline

Multiply RealDoubles

Parameters

other of type Complex

Definition at line 253 of file real_double.h.

     {
         return number(i
                       * std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_)));
     }

◆ mulreal() [2/4]

RCP<const Number> SymEngine::RealDouble::mulreal ( const Integer & other ) const

inline

Multiply RealDoubles

Parameters

other of type Integer

Definition at line 232 of file real_double.h.

     {
         if (other.is_zero()) {
             return zero;
         }
         return make_rcp<const RealDouble>(i
                                           * mp_get_d(other.as_integer_class()));
     }

◆ mulreal() [3/4]

RCP<const Number> SymEngine::RealDouble::mulreal ( const Rational & other ) const

inline

Multiply RealDoubles

Parameters

other of type Rational

Definition at line 244 of file real_double.h.

     {
         return make_rcp<const RealDouble>(
             i * mp_get_d(other.as_rational_class()));
     }

◆ mulreal() [4/4]

RCP<const Number> SymEngine::RealDouble::mulreal ( const RealDouble & other ) const

inline

Multiply RealDoubles

Parameters

other of type RealDouble

Definition at line 263 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i * other.i);
     }

◆ powreal() [1/4]

RCP<const Number> SymEngine::RealDouble::powreal ( const Complex & other ) const

inline

Raise RealDouble to power other

Parameters

other of type Complex

Definition at line 403 of file real_double.h.

     {
         return number(
             std::pow(i, std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_))));
     }

◆ powreal() [2/4]

RCP<const Number> SymEngine::RealDouble::powreal ( const Integer & other ) const

inline

Raise RealDouble to power other

Parameters

other of type Integer

Definition at line 381 of file real_double.h.

     {
         return make_rcp<const RealDouble>(
             std::pow(i, mp_get_d(other.as_integer_class())));
     }

◆ powreal() [3/4]

RCP<const Number> SymEngine::RealDouble::powreal ( const Rational & other ) const

inline

Raise RealDouble to power other

Parameters

other of type Rational

Definition at line 390 of file real_double.h.

     {
         if (i < 0) {
             return number(std::pow(std::complex<double>(i),
                                    mp_get_d(other.as_rational_class())));
         }
         return make_rcp<const RealDouble>(
             std::pow(i, mp_get_d(other.as_rational_class())));
     }

◆ powreal() [4/4]

RCP<const Number> SymEngine::RealDouble::powreal ( const RealDouble & other ) const

inline

Raise RealDouble to power other

Parameters

other of type RealDouble

Definition at line 413 of file real_double.h.

     {
         if (i < 0) {
             return number(std::pow(std::complex<double>(i), other.i));
         }
         return make_rcp<const RealDouble>(std::pow(i, other.i));
     }

◆ rdivreal() [1/3]

RCP<const Number> SymEngine::RealDouble::rdivreal ( const Complex & other ) const

inline

Divide RealDoubles

Parameters

other of type Complex

Definition at line 357 of file real_double.h.

     {
         return number(std::complex<double>(mp_get_d(other.real_),
                                            mp_get_d(other.imaginary_))
                       / i);
     }

◆ rdivreal() [2/3]

RCP<const Number> SymEngine::RealDouble::rdivreal ( const Integer & other ) const

inline

Divide RealDoubles

Parameters

other of type Integer

Definition at line 339 of file real_double.h.

     {
         return make_rcp<const RealDouble>(mp_get_d(other.as_integer_class())
                                           / i);
     }

◆ rdivreal() [3/3]

RCP<const Number> SymEngine::RealDouble::rdivreal ( const Rational & other ) const

inline

Divide RealDoubles

Parameters

other of type Rational

Definition at line 348 of file real_double.h.

     {
         return make_rcp<const RealDouble>(mp_get_d(other.as_rational_class())
                                           / i);
     }

◆ rpowreal() [1/3]

RCP<const Number> SymEngine::RealDouble::rpowreal ( const Complex & other ) const

inline

Raise other to power RealDouble

Parameters

other of type Complex

Definition at line 466 of file real_double.h.

     {
         return number(std::pow(std::complex<double>(mp_get_d(other.real_),
                                                     mp_get_d(other.imaginary_)),
                                i));
     }

◆ rpowreal() [2/3]

RCP<const Number> SymEngine::RealDouble::rpowreal ( const Integer & other ) const

inline

Raise other to power RealDouble

Parameters

other of type Integer

Definition at line 440 of file real_double.h.

     {
         if (other.is_negative()) {
             return number(std::pow(mp_get_d(other.as_integer_class()),
                                    std::complex<double>(i)));
         }
         return make_rcp<const RealDouble>(
             std::pow(mp_get_d(other.as_integer_class()), i));
     }

◆ rpowreal() [3/3]

RCP<const Number> SymEngine::RealDouble::rpowreal ( const Rational & other ) const

inline

Raise other to power RealDouble

Parameters

other of type Rational

Definition at line 453 of file real_double.h.

     {
         if (other.is_negative()) {
             return number(std::pow(std::complex<double>(i),
                                    mp_get_d(other.as_rational_class())));
         }
         return make_rcp<const RealDouble>(
             std::pow(mp_get_d(other.as_rational_class()), i));
     }

◆ rsubreal() [1/3]

RCP<const Number> SymEngine::RealDouble::rsubreal ( const Complex & other ) const

inline

Subtract RealDoubles

Parameters

other of type Complex

Definition at line 208 of file real_double.h.

     {
         return number(-i
                       + std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_)));
     }

◆ rsubreal() [2/3]

RCP<const Number> SymEngine::RealDouble::rsubreal ( const Integer & other ) const

inline

Subtract RealDoubles

Parameters

other of type Integer

Definition at line 190 of file real_double.h.

     {
         return make_rcp<const RealDouble>(mp_get_d(other.as_integer_class())
                                           - i);
     }

◆ rsubreal() [3/3]

RCP<const Number> SymEngine::RealDouble::rsubreal ( const Rational & other ) const

inline

Subtract RealDoubles

Parameters

other of type Rational

Definition at line 199 of file real_double.h.

     {
         return make_rcp<const RealDouble>(mp_get_d(other.as_rational_class())
                                           - i);
     }

◆ subreal() [1/4]

RCP<const Number> SymEngine::RealDouble::subreal ( const Complex & other ) const

inline

Subtract RealDoubles

Parameters

other of type Complex

Definition at line 156 of file real_double.h.

     {
         return number(i
                       - std::complex<double>(mp_get_d(other.real_),
                                              mp_get_d(other.imaginary_)));
     }

◆ subreal() [2/4]

RCP<const Number> SymEngine::RealDouble::subreal ( const Integer & other ) const

inline

Subtract RealDoubles

Parameters

other of type Integer

Definition at line 138 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i
                                           - mp_get_d(other.as_integer_class()));
     }

◆ subreal() [3/4]

RCP<const Number> SymEngine::RealDouble::subreal ( const Rational & other ) const

inline

Subtract RealDoubles

Parameters

other of type Rational

Definition at line 147 of file real_double.h.

     {
         return make_rcp<const RealDouble>(
             i - mp_get_d(other.as_rational_class()));
     }

◆ subreal() [4/4]

RCP<const Number> SymEngine::RealDouble::subreal ( const RealDouble & other ) const

inline

Subtract RealDoubles

Parameters

other of type RealDouble

Definition at line 166 of file real_double.h.

     {
         return make_rcp<const RealDouble>(i - other.i);
     }

Field Documentation

◆ type_code_id

const TypeID SymEngine::RealDouble::type_code_id = SYMENGINE_REAL_DOUBLE

static

Type_code_id shared by all instances

Definition at line 25 of file real_double.h.

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

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

Public Member Functions

Data Fields

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ addreal() [1/4]

◆ addreal() [2/4]

◆ addreal() [3/4]

◆ addreal() [4/4]

◆ as_double()

◆ compare()

◆ divreal() [1/4]

◆ divreal() [2/4]

◆ divreal() [3/4]

◆ divreal() [4/4]

◆ is_complex()

◆ is_exact()

◆ is_minus_one()

◆ is_negative()

◆ is_one()

◆ is_positive()

◆ is_zero()

◆ mulreal() [1/4]

◆ mulreal() [2/4]

◆ mulreal() [3/4]

◆ mulreal() [4/4]

◆ powreal() [1/4]

◆ powreal() [2/4]

◆ powreal() [3/4]

◆ powreal() [4/4]

◆ rdivreal() [1/3]

◆ rdivreal() [2/3]

◆ rdivreal() [3/3]

◆ rpowreal() [1/3]

◆ rpowreal() [2/3]

◆ rpowreal() [3/3]

◆ rsubreal() [1/3]

◆ rsubreal() [2/3]

◆ rsubreal() [3/3]

◆ subreal() [1/4]

◆ subreal() [2/4]

◆ subreal() [3/4]

◆ subreal() [4/4]

Field Documentation

◆ type_code_id

◆ eq()

◆ hash()