carl  24.04
Computer ARithmetic Library
carl::DivisionLookupResult< Polynomial > Struct Template Reference

The result of. More...

#include <DivisionLookupResult.h>

Collaboration diagram for carl::DivisionLookupResult< Polynomial >:

Public Member Functions

 DivisionLookupResult ()
 
 DivisionLookupResult (const DivisionLookupResult &d)
 
virtual ~DivisionLookupResult ()
 
 DivisionLookupResult (const Polynomial *divisor, const Term< typename Polynomial::CoeffType > &factor)
 
bool success ()
 

Data Fields

const Polynomial *const mDivisor
 
Term< typename Polynomial::CoeffType > mFactor
 

Detailed Description

template<typename Polynomial>
struct carl::DivisionLookupResult< Polynomial >

The result of.

Notice that the DivisionLookupResult does not take ownership of the elements, i.e. during destruction, nothing happens. Furthermore, if the original divisor element is erased, the divisor becomes invalid. Instances of DivisionLookupResults are therefore merely suitable for passing information to be directly processed.

Definition at line 21 of file DivisionLookupResult.h.

Constructor & Destructor Documentation

◆ DivisionLookupResult() [1/3]

template<typename Polynomial >
carl::DivisionLookupResult< Polynomial >::DivisionLookupResult ( )
inline

Definition at line 23 of file DivisionLookupResult.h.

◆ DivisionLookupResult() [2/3]

template<typename Polynomial >
carl::DivisionLookupResult< Polynomial >::DivisionLookupResult ( const DivisionLookupResult< Polynomial > &  d)
inline

Definition at line 29 of file DivisionLookupResult.h.

◆ ~DivisionLookupResult()

template<typename Polynomial >
virtual carl::DivisionLookupResult< Polynomial >::~DivisionLookupResult ( )
inlinevirtual

Definition at line 36 of file DivisionLookupResult.h.

◆ DivisionLookupResult() [3/3]

template<typename Polynomial >
carl::DivisionLookupResult< Polynomial >::DivisionLookupResult ( const Polynomial *  divisor,
const Term< typename Polynomial::CoeffType > &  factor 
)
inline

Definition at line 41 of file DivisionLookupResult.h.

Member Function Documentation

◆ success()

template<typename Polynomial >
bool carl::DivisionLookupResult< Polynomial >::success ( )
inline

Definition at line 47 of file DivisionLookupResult.h.

Here is the caller graph for this function:

Field Documentation

◆ mDivisor

template<typename Polynomial >
const Polynomial* const carl::DivisionLookupResult< Polynomial >::mDivisor

Definition at line 53 of file DivisionLookupResult.h.

◆ mFactor

template<typename Polynomial >
Term<typename Polynomial::CoeffType> carl::DivisionLookupResult< Polynomial >::mFactor

Definition at line 54 of file DivisionLookupResult.h.


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