SymEngine::Interval Class Reference
+ Inheritance diagram for SymEngine::Interval:
+ Collaboration diagram for SymEngine::Interval:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 Test equality. More...
 
virtual int compare (const Basic &o) const
 
 Interval (const RCP< const Number > &start, const RCP< const Number > &end, const bool left_open=false, const bool right_open=false)
 
RCP< const Setopen () const
 
RCP< const Setclose () const
 
RCP< const SetLopen () const
 
RCP< const SetRopen () const
 
virtual RCP< const Setset_union (const RCP< const Set > &o) const
 
virtual RCP< const Setset_intersection (const RCP< const Set > &o) const
 
virtual RCP< const Setset_complement (const RCP< const Set > &o) const
 
virtual RCP< const Booleancontains (const RCP< const Basic > &a) const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
const RCP< const Number > & get_start () const
 
const RCP< const Number > & get_end () const
 
const bool & get_left_open () const
 
const bool & get_right_open () const
 
- Public Member Functions inherited from SymEngine::Set
bool is_subset (const RCP< const Set > &o) const
 
bool is_proper_subset (const RCP< const Set > &o) const
 
bool is_superset (const RCP< const Set > &o) const
 
bool is_proper_superset (const RCP< const Set > &o) 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.
 
Basicoperator= (const Basic &)=delete
 Assignment operator in continuation with above.
 
 Basic (Basic &&)=delete
 Delete the move constructor and assignment.
 
Basicoperator= (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
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'.
 
RCP< const Basicxreplace (const map_basic_basic &subs_dict) const
 
virtual RCP< const Basicexpand_as_exp () const
 expands the special function in terms of exp function
 
RCP< const Basicdiff (const RCP< const Symbol > &x, bool cache=true) const
 
- Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basicrcp_from_this ()
 Get RCP<T> pointer to self (it will cast the pointer to T)
 
RCP< const Basicrcp_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 bool is_canonical (const RCP< const Number > &start, const RCP< const Number > &end, bool left_open, bool right_open)
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_INTERVAL
 

Private Attributes

RCP< const Numberstart_
 
RCP< const Numberend_
 
bool left_open_
 
bool right_open_
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 145 of file sets.h.

Member Function Documentation

◆ __eq__()

bool SymEngine::Interval::__eq__ ( const Basic o) const
virtual

Test equality.

A virtual function for testing the equality of two Basic objects

Deprecated:
Use eq(const Basic &a, const Basic &b) non-member method
Parameters
oa constant reference to object to test against
Returns
True if this is equal to o

Implements SymEngine::Basic.

Definition at line 43 of file sets.cpp.

44 {
45  if (is_a<Interval>(o)) {
46  const Interval &s = down_cast<const Interval &>(o);
47  return ((this->left_open_ == s.left_open_)
48  and (this->right_open_ == s.right_open_)
49  and eq(*this->start_, *s.start_) and eq(*this->end_, *s.end_));
50  }
51  return false;
52 }
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21

◆ __hash__()

hash_t SymEngine::Interval::__hash__ ( ) const
virtual

Calculates the hash of the given SymEngine class. Use Basic.hash() which gives a cached version of the hash.

Returns
64-bit integer value for the hash

Implements SymEngine::Basic.

Definition at line 33 of file sets.cpp.

34 {
35  hash_t seed = SYMENGINE_INTERVAL;
36  hash_combine<Basic>(seed, *start_);
37  hash_combine<Basic>(seed, *end_);
38  hash_combine<bool>(seed, left_open_);
39  hash_combine<bool>(seed, right_open_);
40  return seed;
41 }

◆ compare()

int SymEngine::Interval::compare ( const Basic o) const
virtual

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 54 of file sets.cpp.

55 {
56  // compares two interval based on their length
57  SYMENGINE_ASSERT(is_a<Interval>(s))
58  const Interval &o = down_cast<const Interval &>(s);
59  if (left_open_ and not o.left_open_) {
60  return -1;
61  } else if (not left_open_ and o.left_open_) {
62  return 1;
63  } else if (right_open_ and not o.right_open_) {
64  return 1;
65  } else if (not right_open_ and o.right_open_) {
66  return -1;
67  } else {
68  auto temp = start_->__cmp__(*(o.start_));
69  if (temp != 0) {
70  return temp;
71  } else {
72  return end_->__cmp__(*(o.end_));
73  }
74  }
75 }

Field Documentation

◆ type_code_id

const TypeID SymEngine::Interval::type_code_id = SYMENGINE_INTERVAL
static

Type_code_id shared by all instances

Definition at line 153 of file sets.h.


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