PARTONS/NumA++  
Numerical Analysis C++ routines
Public Types | Public Member Functions | Private Attributes | List of all members
NumA::IntegratorType1D Class Reference

Type of one-dimensional integrations (wrapper for enum). More...

Public Types

enum  Type {
  UNDEFINED = 0, TRAPEZOIDAL = 1, TRAPEZOIDALLOG = 2, GL = 3,
  DEXP = 4, GK21_ADAPTIVE = 5
}
 Type of integration. More...
 

Public Member Functions

 IntegratorType1D ()
 Default constructor. More...
 
 IntegratorType1D (Type type)
 Assignment constructor. More...
 
 IntegratorType1D (const std::string &integratorType1DString)
 Assignment constructor trying to match integration type from given string. More...
 
virtual ~IntegratorType1D ()
 Default destructor. More...
 
 operator Type () const
 Operator that casts back into an enum. More...
 
std::string toString () const
 Returns a formatted string displaying the type. More...
 
std::string getShortName ()
 Returns a short name for the type. More...
 
IntegratorType1D::Type getType () const
 Returns the wrapped enum. More...
 
void setType (Type type)
 Set the type of integration. More...
 

Private Attributes

IntegratorType1D::Type m_type
 Type of integration (enum). More...
 

Detailed Description

Type of one-dimensional integrations (wrapper for enum).

See Integrator1D documentation for an example.

Member Enumeration Documentation

◆ Type

Type of integration.

Enumerator
UNDEFINED 

Undefined type.

TRAPEZOIDAL 

Trapezoidal method with a fixed number of equidistant steps.

TRAPEZOIDALLOG 

Trapezoidal method with a fixed number with equidistantly distributed steps in [ln(min), ln(max)] range.

GL 

Gauss-Legendre method with a fixed number of steps.

DEXP 

Adaptive double exponential method.

GK21_ADAPTIVE 

Adaptive Gauss-Kronrod method with 21 point rules.

Constructor & Destructor Documentation

◆ IntegratorType1D() [1/3]

NumA::IntegratorType1D::IntegratorType1D ( )

Default constructor.

◆ IntegratorType1D() [2/3]

NumA::IntegratorType1D::IntegratorType1D ( Type  type)

Assignment constructor.

Parameters
typeType to be assigned.

◆ IntegratorType1D() [3/3]

NumA::IntegratorType1D::IntegratorType1D ( const std::string &  integratorType1DString)

Assignment constructor trying to match integration type from given string.

If unable to match set IntegratorType1D::UNDEFINED.

Parameters
integratorType1DStringString to be matched.

◆ ~IntegratorType1D()

NumA::IntegratorType1D::~IntegratorType1D ( )
virtual

Default destructor.

Member Function Documentation

◆ getShortName()

std::string NumA::IntegratorType1D::getShortName ( )

Returns a short name for the type.

Returns
std::string

◆ getType()

IntegratorType1D::Type NumA::IntegratorType1D::getType ( ) const

Returns the wrapped enum.

Returns
IntegratorType1D::Type

◆ operator Type()

NumA::IntegratorType1D::operator IntegratorType1D::Type ( ) const

Operator that casts back into an enum.

◆ setType()

void NumA::IntegratorType1D::setType ( Type  type)

Set the type of integration.

Parameters
typeIntegration type to be set.

◆ toString()

std::string NumA::IntegratorType1D::toString ( ) const

Returns a formatted string displaying the type.

Returns
std::string

Member Data Documentation

◆ m_type

IntegratorType1D::Type NumA::IntegratorType1D::m_type
private

Type of integration (enum).


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