GiNaC::expair Class Reference

A pair of expressions. More...

#include <expair.h>

Public Member Functions
	expair ()
	expair (const ex &r, const ex &c)
	Construct an expair from two ex.
bool	is_equal (const expair &other) const
	Member-wise check for canonical ordering equality.
bool	is_less (const expair &other) const
	Member-wise check for canonical ordering lessness.
int	compare (const expair &other) const
	Member-wise check for canonical ordering.
void	print (std::ostream &os) const
bool	is_canonical_numeric () const
	True if this is of the form (numeric,ex(1)).
void	swap (expair &other)
	Swap contents with other expair.
const expair	conjugate () const

Public Attributes
ex	rest
	first member of pair, an arbitrary expression
ex	coeff
	second member of pair, must be numeric

Detailed Description

A pair of expressions.

This is similar to STL's pair<>. It is slightly extended since we need to account for methods like .compare(). Also, since this is meant for use by class expairseq it must satisfy the invariance that the member coeff must be of type numeric.

Definition at line 36 of file expair.h.

Constructor & Destructor Documentation

expair() [1/2]

GiNaC::expair::expair ( )

inline

Definition at line 39 of file expair.h.

Referenced by conjugate().

expair() [2/2]

GiNaC::expair::expair ( const ex &  r, const ex &  c  )

inline

Construct an expair from two ex.

Definition at line 42 of file expair.h.

References coeff, and GINAC_ASSERT.

Member Function Documentation

is_equal()

bool GiNaC::expair::is_equal ( const expair &  other ) const

inline

Member-wise check for canonical ordering equality.

Definition at line 48 of file expair.h.

References coeff, GiNaC::ex::is_equal(), and rest.

Referenced by GiNaC::expairseq::evalchildren(), GiNaC::mul::expair_needs_further_processing(), and GiNaC::expairseq::subschildren().

is_less()

bool GiNaC::expair::is_less ( const expair &  other ) const

inline

Member-wise check for canonical ordering lessness.

Definition at line 54 of file expair.h.

References coeff, GiNaC::ex::compare(), and rest.

Referenced by GiNaC::expair_is_less::operator()().

compare()

int GiNaC::expair::compare ( const expair &  other ) const

inline

Member-wise check for canonical ordering.

Definition at line 62 of file expair.h.

References coeff, GiNaC::ex::compare(), and rest.

print()

void GiNaC::expair::print

(

std::ostream &

os

)

const

Definition at line 27 of file expair.cpp.

References c, coeff, GiNaC::ex::print(), and rest.

is_canonical_numeric()

bool GiNaC::expair::is_canonical_numeric ( ) const

inline

True if this is of the form (numeric,ex(1)).

Definition at line 74 of file expair.h.

References coeff, GINAC_ASSERT, GiNaC::ex::is_equal(), and rest.

swap()

void GiNaC::expair::swap ( expair &  other )

inline

Swap contents with other expair.

Definition at line 81 of file expair.h.

References coeff, rest, and GiNaC::ex::swap().

Referenced by GiNaC::mul::derivative(), GiNaC::expair_swap::operator()(), and GiNaC::swap().

conjugate()

const expair GiNaC::expair::conjugate

(

)

const

Definition at line 35 of file expair.cpp.

References GiNaC::are_ex_trivially_equal(), coeff, GiNaC::ex::conjugate(), expair(), and rest.

Member Data Documentation

rest

ex GiNaC::expair::rest

first member of pair, an arbitrary expression

Definition at line 89 of file expair.h.

Referenced by GiNaC::expairseq::combine_pair_with_coeff_to_pair(), GiNaC::add::combine_pair_with_coeff_to_pair(), GiNaC::mul::combine_pair_with_coeff_to_pair(), compare(), conjugate(), GiNaC::expairseq::construct_from_2_ex(), GiNaC::expairseq::construct_from_expairseq_ex(), is_canonical_numeric(), is_equal(), is_less(), GiNaC::expair_rest_is_less::operator()(), print(), GiNaC::expairseq::printpair(), GiNaC::expairseq::recombine_pair_to_ex(), GiNaC::add::recombine_pair_to_ex(), GiNaC::mul::recombine_pair_to_ex(), and swap().

coeff

ex GiNaC::expair::coeff

second member of pair, must be numeric

Definition at line 90 of file expair.h.

Referenced by GiNaC::mul::can_make_flat(), GiNaC::expairseq::combine_pair_with_coeff_to_pair(), GiNaC::add::combine_pair_with_coeff_to_pair(), GiNaC::mul::combine_pair_with_coeff_to_pair(), compare(), conjugate(), GiNaC::expairseq::construct_from_2_ex(), GiNaC::expairseq::construct_from_expairseq_ex(), expair(), GiNaC::power::expand_mul(), is_canonical_numeric(), is_equal(), is_less(), print(), GiNaC::expairseq::printpair(), GiNaC::expairseq::recombine_pair_to_ex(), GiNaC::add::recombine_pair_to_ex(), GiNaC::mul::recombine_pair_to_ex(), and swap().

---

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

• expair.h
• expair.cpp