SymEngine::Max Class Reference

Inheritance diagram for SymEngine::Max:

Collaboration diagram for SymEngine::Max:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Max (const vec_basic &&arg)
	Max Constructor.
bool	is_canonical (const vec_basic &arg) const
RCP< const Basic >	create (const vec_basic &arg) const override
Public Member Functions inherited from SymEngine::MultiArgFunction
	MultiArgFunction (const vec_basic &arg)
	Constructor.
hash_t	__hash__ () const override
vec_basic	get_args () const override
	Returns the list of arguments.
const vec_basic &	get_vec () const
virtual RCP< const Basic >	create (const vec_basic &v) const =0
	Method to construct classes with canonicalization.
bool	__eq__ (const Basic &o) const override
int	compare (const Basic &o) const override
	Structural equality comparator.
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 Attributes
static const TypeID	type_code_id = SYMENGINE_MAX

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.
Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 1258 of file functions.h.

Constructor & Destructor Documentation

Max()

SymEngine::Max::Max

(

const vec_basic &&

arg

)

Max Constructor.

Definition at line 3525 of file functions.cpp.

                              : MultiArgFunction(std::move(arg))
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(get_vec()))
}

Member Function Documentation

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

create()

RCP< const Basic > SymEngine::Max::create ( const vec_basic &  arg ) const

overridevirtual

Returns

canonicalized Max

Implements SymEngine::MultiArgFunction.

Definition at line 3550 of file functions.cpp.

{
    return max(a);
}

is_canonical()

bool SymEngine::Max::is_canonical

(

const vec_basic &

arg

)

const

Returns

true if canonical

Definition at line 3531 of file functions.cpp.

{
    if (arg.size() < 2)
        return false;
 
    bool non_number_exists = false;
 
    for (const auto &p : arg) {
        if (is_a<Complex>(*p) or is_a<Max>(*p))
            return false;
        if (not is_a_Number(*p))
            non_number_exists = true;
    }
    if (not std::is_sorted(arg.begin(), arg.end(), RCPBasicKeyLess()))
        return false;
 
    return non_number_exists; // all arguments cant be numbers
}

Field Documentation

type_code_id

const TypeID SymEngine::Max::type_code_id = SYMENGINE_MAX

static

Type_code_id shared by all instances

Definition at line 1261 of file functions.h.

---

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

• /home/runner/work/symengine/symengine/symengine/functions.h
• /home/runner/work/symengine/symengine/symengine/functions.cpp