carl  24.04
Computer ARithmetic Library
carl::CriticalPairs< Datastructure, Configuration > Class Template Reference

A data structure to store all the SPolynomial pairs which have to be checked. More...

#include <CriticalPairs.h>

Public Member Functions

 CriticalPairs ()
 
void push (std::list< SPolPair > pairs)
 Add a list of s-pairs to the list. More...
 
SPolPair pop ()
 Gets the first SPol from the data structure and removes it from the data structure. More...
 
void elimMultiples (const Monomial::Arg &lm, const std::unordered_map< size_t, SPolPair > &newpairs)
 Eliminate multiples of the given monomial. More...
 
bool empty () const
 Checks whether there are any pairs in the data structure. More...
 
void print () const
 Print the underlying data structure. More...
 
unsigned size () const
 Checks the size of the data structure. More...
 

Private Attributes

Datastructure< Configuration > mDatastruct
 

Detailed Description

template<template< class > class Datastructure, class Configuration>
class carl::CriticalPairs< Datastructure, Configuration >

A data structure to store all the SPolynomial pairs which have to be checked.

Definition at line 53 of file CriticalPairs.h.

Constructor & Destructor Documentation

◆ CriticalPairs()

template<template< class > class Datastructure, class Configuration >
carl::CriticalPairs< Datastructure, Configuration >::CriticalPairs ( )
inline

Definition at line 57 of file CriticalPairs.h.

Member Function Documentation

◆ elimMultiples()

template<template< class > class Datastructure, class Configuration >
void carl::CriticalPairs< Datastructure, Configuration >::elimMultiples ( const Monomial::Arg lm,
const std::unordered_map< size_t, SPolPair > &  newpairs 
)

Eliminate multiples of the given monomial.

Parameters
lm
newpairs

◆ empty()

template<template< class > class Datastructure, class Configuration >
bool carl::CriticalPairs< Datastructure, Configuration >::empty ( ) const
inline

Checks whether there are any pairs in the data structure.

Returns

Definition at line 88 of file CriticalPairs.h.

◆ pop()

template<template< class > class Datastructure, class Configuration >
SPolPair carl::CriticalPairs< Datastructure, Configuration >::pop ( )

Gets the first SPol from the data structure and removes it from the data structure.

Returns

◆ print()

template<template< class > class Datastructure, class Configuration >
void carl::CriticalPairs< Datastructure, Configuration >::print ( ) const
inline

Print the underlying data structure.

Definition at line 96 of file CriticalPairs.h.

◆ push()

template<template< class > class Datastructure, class Configuration >
void carl::CriticalPairs< Datastructure, Configuration >::push ( std::list< SPolPair pairs)
inline

Add a list of s-pairs to the list.

Parameters
pairs

Definition at line 66 of file CriticalPairs.h.

◆ size()

template<template< class > class Datastructure, class Configuration >
unsigned carl::CriticalPairs< Datastructure, Configuration >::size ( ) const
inline

Checks the size of the data structure.

Please notice that this is not necessarily the number of pairs in the data structure, as the underlying elements may be lists themselves.

Returns

Definition at line 106 of file CriticalPairs.h.

Field Documentation

◆ mDatastruct

template<template< class > class Datastructure, class Configuration >
Datastructure<Configuration> carl::CriticalPairs< Datastructure, Configuration >::mDatastruct
private

Definition at line 112 of file CriticalPairs.h.


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