carl  24.04
Computer ARithmetic Library
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
carl::RealRootsResult< RAN > Class Template Reference

#include <RealRoots.h>

Data Structures

struct  non_univariate_t
 
struct  nullified_t
 

Public Types

using roots_t = std::vector< RAN >
 

Public Member Functions

bool is_nullified () const
 
bool is_univariate () const
 
bool is_non_univariate () const
 
const roots_t & roots () const
 

Static Public Member Functions

static RealRootsResult nullified_response ()
 
static RealRootsResult non_univariate_response ()
 
static RealRootsResult roots_response (roots_t &&real_roots)
 
static RealRootsResult no_roots_response ()
 

Private Member Functions

 RealRootsResult (nullified_t)
 
 RealRootsResult (non_univariate_t)
 
 RealRootsResult (roots_t &&real_roots)
 

Private Attributes

std::variant< roots_t, nullified_t, non_univariate_t > m_data
 

Detailed Description

template<typename RAN>
class carl::RealRootsResult< RAN >

Definition at line 10 of file RealRoots.h.

Member Typedef Documentation

◆ roots_t

template<typename RAN >
using carl::RealRootsResult< RAN >::roots_t = std::vector<RAN>

Definition at line 13 of file RealRoots.h.

Constructor & Destructor Documentation

◆ RealRootsResult() [1/3]

template<typename RAN >
carl::RealRootsResult< RAN >::RealRootsResult ( nullified_t  )
inlineprivate

Definition at line 20 of file RealRoots.h.

Here is the caller graph for this function:

◆ RealRootsResult() [2/3]

template<typename RAN >
carl::RealRootsResult< RAN >::RealRootsResult ( non_univariate_t  )
inlineprivate

Definition at line 22 of file RealRoots.h.

◆ RealRootsResult() [3/3]

template<typename RAN >
carl::RealRootsResult< RAN >::RealRootsResult ( roots_t &&  real_roots)
inlineprivate

Definition at line 24 of file RealRoots.h.

Member Function Documentation

◆ is_non_univariate()

template<typename RAN >
bool carl::RealRootsResult< RAN >::is_non_univariate ( ) const
inline

Definition at line 49 of file RealRoots.h.

◆ is_nullified()

template<typename RAN >
bool carl::RealRootsResult< RAN >::is_nullified ( ) const
inline

Definition at line 41 of file RealRoots.h.

◆ is_univariate()

template<typename RAN >
bool carl::RealRootsResult< RAN >::is_univariate ( ) const
inline

Definition at line 45 of file RealRoots.h.

◆ no_roots_response()

template<typename RAN >
static RealRootsResult carl::RealRootsResult< RAN >::no_roots_response ( )
inlinestatic

Definition at line 37 of file RealRoots.h.

Here is the call graph for this function:

◆ non_univariate_response()

template<typename RAN >
static RealRootsResult carl::RealRootsResult< RAN >::non_univariate_response ( )
inlinestatic

Definition at line 31 of file RealRoots.h.

Here is the call graph for this function:

◆ nullified_response()

template<typename RAN >
static RealRootsResult carl::RealRootsResult< RAN >::nullified_response ( )
inlinestatic

Definition at line 28 of file RealRoots.h.

Here is the call graph for this function:

◆ roots()

template<typename RAN >
const roots_t& carl::RealRootsResult< RAN >::roots ( ) const
inline

Definition at line 53 of file RealRoots.h.

◆ roots_response()

template<typename RAN >
static RealRootsResult carl::RealRootsResult< RAN >::roots_response ( roots_t &&  real_roots)
inlinestatic

Definition at line 34 of file RealRoots.h.

Here is the call graph for this function:

Field Documentation

◆ m_data

template<typename RAN >
std::variant<roots_t, nullified_t, non_univariate_t> carl::RealRootsResult< RAN >::m_data
private

Definition at line 18 of file RealRoots.h.

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