CFIterator Class Reference

class to iterate through CanonicalForm's More...

#include <cf_iter.h>

Public Member Functions
	CFIterator ()
	CFIterator (const CFIterator &)
	CFIterator (const CanonicalForm &)
	CFIterator (const CanonicalForm &, const Variable &)
	~CFIterator ()
CFIterator &	operator= (const CFIterator &)
CFIterator &	operator= (const CanonicalForm &)
CF_NO_INLINE CFIterator &	operator++ ()
	CFIterator::operator ++ (), operator ++ ( int ) More...
CF_NO_INLINE CFIterator &	operator++ (int)
CF_NO_INLINE int	hasTerms () const
	check if iterator has reached the end of CanonicalForm More...
CF_NO_INLINE CanonicalForm	coeff () const
	get the current coefficient More...
CF_NO_INLINE int	exp () const
	get the current exponent More...

Private Attributes
CanonicalForm	data
termList	cursor
bool	ispoly
bool	hasterms

Detailed Description

class to iterate through CanonicalForm's

Note

a (multivariate) polynomial is viewed as a univariate poly in its main variable

Definition at line 44 of file cf_iter.h.

Constructor & Destructor Documentation

CFIterator() [1/4]

CFIterator::CFIterator

(

)

Definition at line 15 of file cf_iter.cc.

{
    data = 0; cursor = 0;
    ispoly = false; hasterms = false;
}

CFIterator() [2/4]

CFIterator::CFIterator

(

const CFIterator &

i

)

Definition at line 21 of file cf_iter.cc.

{
    data = i.data;
    cursor = i.cursor;
    ispoly = i.ispoly;
    hasterms = i.hasterms;
}

CFIterator() [3/4]

CFIterator::CFIterator

(

const CanonicalForm &

f

)

Definition at line 29 of file cf_iter.cc.

{
    if ( f.inBaseDomain() || f.inQuotDomain() )
    {
        data = f; cursor = 0;
        ispoly = false; hasterms = true;
    }
    else
    {
        data = f;
        cursor = ((InternalPoly*)(f.value))->firstTerm;
        ispoly = true; hasterms = true;
    }
}

CFIterator() [4/4]

CFIterator::CFIterator	(	const CanonicalForm &	f,
		const Variable &	v
	)

Definition at line 44 of file cf_iter.cc.

{
    ASSERT( !f.inQuotDomain(), "illegal iterator" );
    ASSERT( v.level() > 0, "illegal iterator" );
    if ( f.inBaseDomain() )
    {
        data = f; cursor = 0;
        ispoly = false; hasterms = true;
    }
    else
    {
        if ( f.mvar() == v )
        {
            data = f;
            cursor = ((InternalPoly*)(f.value))->firstTerm;
            ispoly = true; hasterms = true;
        }
        else  if ( v > f.mvar() )
        {
            data = f; cursor = 0;
            ispoly = false; hasterms = true;
        }
        else
        {
            data = swapvar( f, v, f.mvar().next() );
            if ( data.mvar() == f.mvar().next() )
            {
                cursor = ((InternalPoly*)(data.value))->firstTerm;
                ispoly = true; hasterms = true;
            }
            else
            {
                cursor = 0;
                ispoly = false; hasterms = true;
            }
        }
    }
}

~CFIterator()

CFIterator::~CFIterator

(

)

Definition at line 83 of file cf_iter.cc.

{
    data = 0; cursor = 0;
}

Member Function Documentation

coeff()

CF_INLINE CanonicalForm CFIterator::coeff

(

)

const

get the current coefficient

CF_INLINE CanonicalForm CFIterator::coeff () const.

coeff() - return coefficient of current term of CO.

CO has to point to a valid term.

Definition at line 88 of file cf_iter_inline.cc.

{
    ASSERT( hasterms, "lib error: iterator out of terms" );
    if ( ispoly )
        return cursor->coeff;
    else
        return data;
}

exp()

CF_INLINE int CFIterator::exp

(

)

const

get the current exponent

CF_INLINE int CFIterator::exp () const.

exp() - return exponent of current term of CO.

CO has to point to a valid term.

Definition at line 105 of file cf_iter_inline.cc.

{
    ASSERT( hasterms, "lib error: iterator out of terms" );
    if ( ispoly )
        return cursor->exp;
    else
        return 0;
}

hasTerms()

CF_INLINE int CFIterator::hasTerms

(

)

const

check if iterator has reached the end of CanonicalForm

CF_INLINE int CFIterator::hasTerms () const.

hasTerm() - check whether CO points to a valid term.

Return true if CO points to a valid term, false if CO points to the end of the sequence of terms.

Definition at line 75 of file cf_iter_inline.cc.

{
    return hasterms;
}

operator++() [1/2]

CF_INLINE CFIterator & CFIterator::operator++

(

)

CFIterator::operator ++ (), operator ++ ( int )

operator ++() - advance CO to next term.

Advance current term to next term in the sequence of terms or to end of sequence. CO has to point to a valid term.

The postfix and prefix operator are identical.

Definition at line 126 of file cf_iter_inline.cc.

{
    ASSERT( hasterms, "lib error: iterator out of terms" );
    if ( ispoly ) {
        cursor = cursor->next;
        hasterms = cursor != 0;
    } else
        hasterms = false;
 
    return *this;
}

operator++() [2/2]

CF_INLINE CFIterator & CFIterator::operator++

(

int

)

See also

CFIterator::operator

Definition at line 142 of file cf_iter_inline.cc.

{
    ASSERT( hasterms, "lib error: iterator out of terms" );
    if ( ispoly ) {
        cursor = cursor->next;
        hasterms = cursor != 0;
    } else
        hasterms = false;
 
    return *this;
}

operator=() [1/2]

CFIterator & CFIterator::operator=

(

const CanonicalForm &

f

)

Definition at line 102 of file cf_iter.cc.

{
    if ( f.inBaseDomain() || f.inQuotDomain() )
    {
        data = f; cursor = 0;
        ispoly = false; hasterms = true;
    }
    else
    {
        data = f;
        cursor = ((InternalPoly*)(f.value))->firstTerm;
        ispoly = true; hasterms = true;
    }
    return *this;
}

operator=() [2/2]

CFIterator & CFIterator::operator=

(

const CFIterator &

i

)

Definition at line 89 of file cf_iter.cc.

{
    if ( this != &i )
    {
        data = i.data;
        cursor = i.cursor;
        ispoly = i.ispoly;
        hasterms = i.hasterms;
    }
    return *this;
}

Field Documentation

cursor

termList CFIterator::cursor

private

Definition at line 47 of file cf_iter.h.

data

CanonicalForm CFIterator::data

private

Definition at line 46 of file cf_iter.h.

hasterms

bool CFIterator::hasterms

private

Definition at line 48 of file cf_iter.h.

ispoly

bool CFIterator::ispoly

private

Definition at line 48 of file cf_iter.h.

---

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

• factory/cf_iter.h
• factory/cf_iter.cc
• factory/cf_iter_inline.cc