- 3.0.2 core module.
ct::core::DerivativesCppadSettings Class Reference

Contains the NLP solver settings. More...

#include <DerivativesCppadSettings.h>

Public Types

enum  CompilerType { GCC = 0, CLANG = 1, num_types_compiler }
 
typedef EIGEN_MAKE_ALIGNED_OPERATOR_NEW enum ct::core::DerivativesCppadSettings::CompilerType Compiler_t
 

Public Member Functions

 DerivativesCppadSettings ()
 Default constructor, set default settings. More...
 
void print ()
 Prints out settings. More...
 
bool parametersOk () const
 Checks whether to settings are filled with meaningful values. More...
 
void load (const std::string &filename, bool verbose=true, const std::string &ns="solver")
 Loads the settings from a .info file. More...
 

Public Attributes

bool multiThreading_
 
bool createForwardZero_
 
bool createForwardOne_
 
bool createReverseOne_
 
bool createReverseTwo_
 
bool createJacobian_
 
bool createSparseJacobian_
 
bool createHessian_
 
bool createSparseHessian_
 
size_t maxAssignements_
 
CompilerType compiler_
 
bool generateSourceCode_
 
bool useDynamicLibrary_
 

Detailed Description

Contains the NLP solver settings.

Member Typedef Documentation

◆ Compiler_t

Member Enumeration Documentation

◆ CompilerType

Enumerator
GCC 
CLANG 
num_types_compiler 

Constructor & Destructor Documentation

◆ DerivativesCppadSettings()

ct::core::DerivativesCppadSettings::DerivativesCppadSettings ( )
inline

Default constructor, set default settings.

Member Function Documentation

◆ print()

void ct::core::DerivativesCppadSettings::print ( )
inline

Prints out settings.

References compiler_.

Referenced by load().

◆ parametersOk()

bool ct::core::DerivativesCppadSettings::parametersOk ( ) const
inline

Checks whether to settings are filled with meaningful values.

Returns
Returns true of the parameters are ok

◆ load()

void ct::core::DerivativesCppadSettings::load ( const std::string &  filename,
bool  verbose = true,
const std::string &  ns = "solver" 
)
inline

Loads the settings from a .info file.

Parameters
[in]filenameThe filename
[in]verboseTrue if parameters to be printed out
[in]nsThe namespace in the .info fil

References CLANG, GCC, print(), and verbose.

Member Data Documentation

◆ multiThreading_

bool ct::core::DerivativesCppadSettings::multiThreading_

◆ createForwardZero_

bool ct::core::DerivativesCppadSettings::createForwardZero_

◆ createForwardOne_

bool ct::core::DerivativesCppadSettings::createForwardOne_

◆ createReverseOne_

bool ct::core::DerivativesCppadSettings::createReverseOne_

◆ createReverseTwo_

bool ct::core::DerivativesCppadSettings::createReverseTwo_

◆ createJacobian_

bool ct::core::DerivativesCppadSettings::createJacobian_

◆ createSparseJacobian_

bool ct::core::DerivativesCppadSettings::createSparseJacobian_

◆ createHessian_

bool ct::core::DerivativesCppadSettings::createHessian_

◆ createSparseHessian_

bool ct::core::DerivativesCppadSettings::createSparseHessian_

◆ maxAssignements_

size_t ct::core::DerivativesCppadSettings::maxAssignements_

◆ compiler_

CompilerType ct::core::DerivativesCppadSettings::compiler_

Referenced by print().

◆ generateSourceCode_

bool ct::core::DerivativesCppadSettings::generateSourceCode_

◆ useDynamicLibrary_

bool ct::core::DerivativesCppadSettings::useDynamicLibrary_

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