Loading...
Searching...
No Matches
SymEngine::LeviCivita Class Reference
+ Inheritance diagram for SymEngine::LeviCivita:
+ Collaboration diagram for SymEngine::LeviCivita:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 LeviCivita (const vec_basic &&arg)
 LeviCivita Constructor. More...
 
bool is_canonical (const vec_basic &arg) const
 
virtual RCP< const Basiccreate (const vec_basic &arg) const
 
- Public Member Functions inherited from SymEngine::MultiArgFunction
 MultiArgFunction (const vec_basic &arg)
 Constructor. More...
 
hash_t __hash__ () const
 
virtual vec_basic get_args () const
 Returns the list of arguments. More...
 
const vec_basicget_vec () const
 
virtual RCP< const Basiccreate (const vec_basic &v) const =0
 Method to construct classes with canonicalization. More...
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 Structural equality comparator. More...
 
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 
 Basic ()
 Constructor. More...
 
 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.
 
virtual hash_t __hash__ () const =0
 
hash_t hash () const
 
virtual bool __eq__ (const Basic &o) const =0
 Test equality. More...
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o. More...
 
int __cmp__ (const Basic &o) const
 Comparison operator. More...
 
virtual int compare (const Basic &o) const =0
 
std::string __str__ () const
 
std::string dumps () const
 Returns a string of the instance serialized. More...
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'. More...
 
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 More...
 
virtual vec_basic get_args () const =0
 Returns the list of arguments. More...
 
virtual void accept (Visitor &v) const =0
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const =0
 
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) More...
 
RCP< const Basicrcp_from_this () const
 Get RCP<const T> pointer to self (it will cast the pointer to const T) More...
 
RCP< const T2 > rcp_from_this_cast () const
 Get RCP<T2> pointer to self (it will cast the pointer to T2) More...
 
unsigned int use_count () const
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_LEVICIVITA
 

Additional Inherited Members

- Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basicloads (const std::string &)
 Creates an instance of a serialized string. More...
 
- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 1011 of file functions.h.

Constructor & Destructor Documentation

◆ LeviCivita()

SymEngine::LeviCivita::LeviCivita ( const vec_basic &&  arg)

LeviCivita Constructor.

Definition at line 2705 of file functions.cpp.

2706{
2707 SYMENGINE_ASSIGN_TYPEID()
2708 SYMENGINE_ASSERT(is_canonical(get_vec()))
2709}
bool is_canonical(const vec_basic &arg) const
Definition: functions.cpp:2711
MultiArgFunction(const vec_basic &arg)
Constructor.
Definition: functions.h:150
T move(T... args)

Member Function Documentation

◆ accept() [1/2]

virtual void SymEngine::LeviCivita::accept ( EvalRealDoubleVisitorFinal v) const
virtual

Implements SymEngine::Basic.

◆ accept() [2/2]

virtual void SymEngine::LeviCivita::accept ( Visitor v) const
virtual

Implements SymEngine::Basic.

◆ create()

RCP< const Basic > SymEngine::LeviCivita::create ( const vec_basic arg) const
virtual
Returns
canonicalized Max

Implements SymEngine::MultiArgFunction.

Definition at line 2729 of file functions.cpp.

2730{
2731 return levi_civita(a);
2732}
RCP< const Basic > levi_civita(const vec_basic &arg)
Canonicalize LeviCivita:
Definition: functions.cpp:2747

◆ is_canonical()

bool SymEngine::LeviCivita::is_canonical ( const vec_basic arg) const
Returns
true if canonical

Definition at line 2711 of file functions.cpp.

2712{
2713 bool are_int = true;
2714 for (const auto &p : arg) {
2715 if (not(is_a_Number(*p))) {
2716 are_int = false;
2717 break;
2718 }
2719 }
2720 if (are_int) {
2721 return false;
2722 } else if (has_dup(arg)) {
2723 return false;
2724 } else {
2725 return true;
2726 }
2727}
bool is_a_Number(const Basic &b)
Definition: number.h:130

Field Documentation

◆ type_code_id

const TypeID SymEngine::LeviCivita::type_code_id = SYMENGINE_LEVICIVITA
static

Represent the Levi-Civita symbol. For even permutations of indices it returns 1, for odd permutations -1, and for everything else (a repeated index) it returns 0.

Thus it represents an alternating pseudotensor.

Type_code_id shared by all instances

Definition at line 1021 of file functions.h.


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