Frobby 0.10.0
Loading...
Searching...
No Matches
LibIdealConsumer Class Reference

#include <LibTest.h>

Inheritance diagram for LibIdealConsumer:
Collaboration diagram for LibIdealConsumer:

Public Member Functions

 LibIdealConsumer (const VarNames &names)
virtual void idealBegin (size_t varCount)
virtual void consume (mpz_ptr *exponentVector)
const BigIdeal & getIdeal () const
bool hasAnyOutput () const
Public Member Functions inherited from Frobby::IdealConsumer
virtual ~IdealConsumer ()
virtual void idealEnd ()

Detailed Description

Records library interface output into a BigIdeal.

Member Function Documentation

◆ consume()

void LibIdealConsumer::consume ( mpz_ptr * exponentVector)
virtual

For output of a generator of the ideal. exponentVector is an array containing the exponents of the generator.

The parameter exponentVector and its entries must not be altered or deallocated, and no reference to them can be retained after the consume method has returned. If the output must be stored, then a copy must be made.

Implements Frobby::IdealConsumer.

◆ getIdeal()

const BigIdeal & LibIdealConsumer::getIdeal ( ) const

Returns the recorded ideal in a canonical form.

◆ hasAnyOutput()

bool LibIdealConsumer::hasAnyOutput ( ) const

Returns whether any ideal has been recorded.

◆ idealBegin()

void LibIdealConsumer::idealBegin ( size_t varCount)
virtual

Called before output of a monomial ideal. varCount is the number of variables of the ring within which the output ideal lies. The provided implementation does nothing.

Reimplemented from Frobby::IdealConsumer.


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