carl  24.04
Computer ARithmetic Library
Public Member Functions | Private Attributes
carl::CriticalPairsEntry< Compare > Class Template Reference

A list of SPol pairs which have to be checked by the Buchberger algorithm. More...

#include <CriticalPairsEntry.h>

Collaboration diagram for carl::CriticalPairsEntry< Compare >:
Collaboration graph
[legend]

Public Member Functions

 CriticalPairsEntry (std::list< SPolPair > &&pairs)
 Saves the list of pairs and sorts them according the configured ordering. More...
 
const Monomial::Arg & getSortedFirstLCM () const
 Get the LCM of the first element. More...
 
const SPolPair & getFirst () const
 Get the front of the list. More...
 
bool update ()
 Removes the first element. More...
 
std::list< SPolPair >::const_iterator getPairsBegin () const noexcept
 The const iterator to the begin. More...
 
std::list< SPolPair >::const_iterator getPairsEnd () const noexcept
 The const iterator to the end() More...
 
std::list< SPolPair >::iterator getPairsBegin () noexcept
 The iterator to the end() More...
 
std::list< SPolPair >::iterator getPairsEnd () noexcept
 The iterator to the end() More...
 
std::list< SPolPair >::iterator erase (std::list< SPolPair >::iterator it)
 Removes the element at the iterator. More...
 
void print (std::ostream &os=std::cout)
 

Private Attributes

std::list< SPolPair > mPairs
 

Detailed Description

template<class Compare>
class carl::CriticalPairsEntry< Compare >

A list of SPol pairs which have to be checked by the Buchberger algorithm.

We keep the list sorted according the compare ordering on SPol Pairs.

Definition at line 25 of file CriticalPairsEntry.h.

Constructor & Destructor Documentation

◆ CriticalPairsEntry()

template<class Compare >
carl::CriticalPairsEntry< Compare >::CriticalPairsEntry ( std::list< SPolPair > &&  pairs)
inlineexplicit

Saves the list of pairs and sorts them according the configured ordering.

Parameters
pairs

Definition at line 33 of file CriticalPairsEntry.h.

Member Function Documentation

◆ erase()

template<class Compare >
std::list<SPolPair>::iterator carl::CriticalPairsEntry< Compare >::erase ( std::list< SPolPair >::iterator  it)
inline

Removes the element at the iterator.

Parameters
itThe iterator to the element to be erased.
Returns
The next element.

Definition at line 101 of file CriticalPairsEntry.h.

◆ getFirst()

template<class Compare >
const SPolPair& carl::CriticalPairsEntry< Compare >::getFirst ( ) const
inline

Get the front of the list.

Returns

Definition at line 51 of file CriticalPairsEntry.h.

◆ getPairsBegin() [1/2]

template<class Compare >
std::list<SPolPair>::const_iterator carl::CriticalPairsEntry< Compare >::getPairsBegin ( ) const
inlinenoexcept

The const iterator to the begin.

Returns
begin of list

Definition at line 68 of file CriticalPairsEntry.h.

◆ getPairsBegin() [2/2]

template<class Compare >
std::list<SPolPair>::iterator carl::CriticalPairsEntry< Compare >::getPairsBegin ( )
inlinenoexcept

The iterator to the end()

Returns
begin of list

Definition at line 84 of file CriticalPairsEntry.h.

◆ getPairsEnd() [1/2]

template<class Compare >
std::list<SPolPair>::const_iterator carl::CriticalPairsEntry< Compare >::getPairsEnd ( ) const
inlinenoexcept

The const iterator to the end()

Returns
end of list

Definition at line 76 of file CriticalPairsEntry.h.

◆ getPairsEnd() [2/2]

template<class Compare >
std::list<SPolPair>::iterator carl::CriticalPairsEntry< Compare >::getPairsEnd ( )
inlinenoexcept

The iterator to the end()

Returns
end of list

Definition at line 92 of file CriticalPairsEntry.h.

◆ getSortedFirstLCM()

template<class Compare >
const Monomial::Arg& carl::CriticalPairsEntry< Compare >::getSortedFirstLCM ( ) const
inline

Get the LCM of the first element.

Returns

Definition at line 42 of file CriticalPairsEntry.h.

Here is the caller graph for this function:

◆ print()

template<class Compare >
void carl::CriticalPairsEntry< Compare >::print ( std::ostream &  os = std::cout)
inline

Definition at line 105 of file CriticalPairsEntry.h.

◆ update()

template<class Compare >
bool carl::CriticalPairsEntry< Compare >::update ( )
inline

Removes the first element.

Returns
empty()

Definition at line 59 of file CriticalPairsEntry.h.

Field Documentation

◆ mPairs

template<class Compare >
std::list<SPolPair> carl::CriticalPairsEntry< Compare >::mPairs
private

Definition at line 112 of file CriticalPairsEntry.h.

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