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

#include <CanonicalTermConsumer.h>

Inheritance diagram for CanonicalTermConsumer:
Collaboration diagram for CanonicalTermConsumer:

Public Member Functions

 CanonicalTermConsumer (unique_ptr< TermConsumer > consumer, size_t varCount, TermTranslator *translator=0)
virtual void consumeRing (const VarNames &names)
virtual void beginConsumingList ()
virtual void beginConsuming ()
virtual void consume (const Term &term)
virtual void doneConsuming ()
virtual void doneConsumingList ()
Public Member Functions inherited from TermConsumer
void consume (const Ideal &ideal)

Detailed Description

Passes consumed items on in a canonical order. This requires storing all items before any can be passed on, which can take a lot of memory. The ideals are not minimized, so adding non-minimal generators can have an effect on the sorted order.

Constructor & Destructor Documentation

◆ CanonicalTermConsumer()

CanonicalTermConsumer::CanonicalTermConsumer ( unique_ptr< TermConsumer > consumer,
size_t varCount,
TermTranslator * translator = 0 )

The translator, if non-null, is used to identify exponents that map to zero, which influences the sorted order.

Member Function Documentation

◆ beginConsuming()

void CanonicalTermConsumer::beginConsuming ( )
virtual

Tell the consumer to begin consuming an ideal. It is required to call this method before calling consume().

Implements TermConsumer.

◆ beginConsumingList()

void CanonicalTermConsumer::beginConsumingList ( )
virtual

This method is not required to be called. If it is called, the list of ideals will be sorted and then passed on. If it is not called, each ideal will be passed on immediately.

Reimplemented from TermConsumer.

◆ consume()

void CanonicalTermConsumer::consume ( const Term & term)
virtual

Consume a term.

Implements TermConsumer.

◆ consumeRing()

void CanonicalTermConsumer::consumeRing ( const VarNames & names)
virtual

Passes on the call immediately. Thus the ordering between when this gets called and when consume gets called on the wrapped consumer can be switched around if consumeRing is called while consuming a list of ideals.

Todo
fix this.

Reimplemented from TermConsumer.

◆ doneConsuming()

void CanonicalTermConsumer::doneConsuming ( )
virtual

Must be called once after each time beginConsuming has been called.

Implements TermConsumer.

◆ doneConsumingList()

void CanonicalTermConsumer::doneConsumingList ( )
virtual

Must be called once after each time beginConsumingList has been called.

Reimplemented from TermConsumer.


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