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

Public Member Functions

virtual void accept (Visitor &v) const
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 Sign (const RCP< const Basic > &arg)
 Sign constructor.
bool is_canonical (const RCP< const Basic > &arg) const
virtual RCP< const Basiccreate (const RCP< const Basic > &arg) const
- Public Member Functions inherited from SymEngine::OneArgFunction
 OneArgFunction (const RCP< const Basic > &arg)
 The arg in OneArgFunction(arg) More...
hash_t __hash__ () const
RCP< const Basicget_arg () const
virtual vec_basic get_args () const
 Returns the list of arguments.
RCP< const Basiccreate (const vec_basic &b) const
virtual bool __eq__ (const Basic &o) const
virtual int compare (const Basic &o) const
 Structural equality comparator.
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 Basic ()
 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 Attributes

static const TypeID type_code_id = SYMENGINE_SIGN

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_

Detailed Description

Definition at line 188 of file functions.h.

Member Function Documentation

◆ create()

RCP< const Basic > SymEngine::Sign::create ( const RCP< const Basic > &  arg) const
Canonicalized sign

Implements SymEngine::OneArgFunction.

Definition at line 479 of file functions.cpp.

480 {
481  return sign(arg);
482 }
RCP< const Basic > sign(const RCP< const Basic > &arg)
Canonicalize Sign.
Definition: functions.cpp:484

◆ is_canonical()

bool SymEngine::Sign::is_canonical ( const RCP< const Basic > &  arg) const
true if canonical

Definition at line 456 of file functions.cpp.

457 {
458  if (is_a_Number(*arg)) {
459  if (eq(*arg, *ComplexInf)) {
460  return true;
461  }
462  return false;
463  }
464  if (is_a<Constant>(*arg)) {
465  return false;
466  }
467  if (is_a<Sign>(*arg)) {
468  return false;
469  }
470  if (is_a<Mul>(*arg)) {
471  if (neq(*down_cast<const Mul &>(*arg).get_coef(), *one)
472  and neq(*down_cast<const Mul &>(*arg).get_coef(), *minus_one)) {
473  return false;
474  }
475  }
476  return true;
477 }
bool is_a_Number(const Basic &b)
Definition: number.h:130
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21
bool neq(const Basic &a, const Basic &b)
Checks inequality for a and b
Definition: basic-inl.h:29

Field Documentation

◆ type_code_id

const TypeID SymEngine::Sign::type_code_id = SYMENGINE_SIGN

Type_code_id shared by all instances

Definition at line 191 of file functions.h.

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