casadi::GlobalOptions Class Reference

Collects global CasADi options. More...

#include <global_options.hpp>

Detailed Description

Note to developers:

• use sparingly. Global options are - in general - a rather bad idea
  
• this class must never be instantiated. Access its static members directly
  

  Author

  Joris Gillis

  Date

  2012

  Extra doc: https://github.com/casadi/casadi/wiki/L_23m

Definition at line 48 of file global_options.hpp.

Static Public Member Functions
static void	setSimplificationOnTheFly (bool flag)
static bool	getSimplificationOnTheFly ()
static void	setHierarchicalSparsity (bool flag)
static bool	getHierarchicalSparsity ()
static void	setCasadiPath (const std::string &path)
static std::string	getCasadiPath ()
static void	setCasadiIncludePath (const std::string &path)
static std::string	getCasadiIncludePath ()
static void	setMaxNumDir (casadi_int ndir)
static casadi_int	getMaxNumDir ()
static void	setCopyElisionMinSize (casadi_int sz)
static casadi_int	getCopyElisionMinSize ()

Static Public Attributes
static bool	simplification_on_the_fly = true
	Indicates whether simplifications should be made on the fly. More...
static std::string	casadipath
static std::string	casadi_include_path
static bool	hierarchical_sparsity = true
static casadi_int	max_num_dir = 64
static casadi_int	start_index = 0
static bool	julia_initialized = false
static casadi_int	copy_elision_min_size = 8

Member Function Documentation

getCasadiIncludePath()

static std::string casadi::GlobalOptions::getCasadiIncludePath ( )

inlinestatic

Definition at line 90 of file global_options.hpp.

{ return casadi_include_path; }

getCasadiPath()

static std::string casadi::GlobalOptions::getCasadiPath ( )

inlinestatic

Definition at line 87 of file global_options.hpp.

{ return casadipath; }

Referenced by casadi::get_search_paths().

getCopyElisionMinSize()

static casadi_int casadi::GlobalOptions::getCopyElisionMinSize ( )

inlinestatic

Definition at line 101 of file global_options.hpp.

{ return copy_elision_min_size; }

getHierarchicalSparsity()

static bool casadi::GlobalOptions::getHierarchicalSparsity ( )

inlinestatic

Definition at line 84 of file global_options.hpp.

{ return hierarchical_sparsity; }

getMaxNumDir()

static casadi_int casadi::GlobalOptions::getMaxNumDir ( )

inlinestatic

Definition at line 93 of file global_options.hpp.

{ return max_num_dir; }

Referenced by casadi::FunctionInternal::FunctionInternal().

getSimplificationOnTheFly()

static bool casadi::GlobalOptions::getSimplificationOnTheFly ( )

inlinestatic

Definition at line 80 of file global_options.hpp.

{ return simplification_on_the_fly; }

setCasadiIncludePath()

static void casadi::GlobalOptions::setCasadiIncludePath ( const std::string &  path )

inlinestatic

Definition at line 89 of file global_options.hpp.

{ casadi_include_path = path; }

References casadi::path().

setCasadiPath()

static void casadi::GlobalOptions::setCasadiPath ( const std::string &  path )

inlinestatic

Definition at line 86 of file global_options.hpp.

{ casadipath = path; }

References casadi::path().

setCopyElisionMinSize()

static void casadi::GlobalOptions::setCopyElisionMinSize ( casadi_int  sz )

inlinestatic

Definition at line 95 of file global_options.hpp.

                                                       {
        copy_elision_min_size=sz;
        if (copy_elision_min_size!=-1 && copy_elision_min_size<2) {
          copy_elision_min_size = 2;
        }
      }

setHierarchicalSparsity()

static void casadi::GlobalOptions::setHierarchicalSparsity ( bool  flag )

inlinestatic

Definition at line 83 of file global_options.hpp.

{ hierarchical_sparsity = flag; }

setMaxNumDir()

static void casadi::GlobalOptions::setMaxNumDir ( casadi_int  ndir )

inlinestatic

Definition at line 92 of file global_options.hpp.

{ max_num_dir=ndir; }

setSimplificationOnTheFly()

static void casadi::GlobalOptions::setSimplificationOnTheFly ( bool  flag )

inlinestatic

Definition at line 79 of file global_options.hpp.

{ simplification_on_the_fly = flag; }

Member Data Documentation

casadi_include_path

std::string casadi::GlobalOptions::casadi_include_path

static

Definition at line 65 of file global_options.hpp.

casadipath

std::string casadi::GlobalOptions::casadipath

static

Definition at line 63 of file global_options.hpp.

copy_elision_min_size

casadi_int casadi::GlobalOptions::copy_elision_min_size = 8

static

Definition at line 75 of file global_options.hpp.

Referenced by casadi::CodeGenerator::elide_copy(), and casadi::SXFunction::init_copy_elision().

hierarchical_sparsity

bool casadi::GlobalOptions::hierarchical_sparsity = true

static

Definition at line 67 of file global_options.hpp.

Referenced by casadi::FunctionInternal::get_jac_sparsity().

julia_initialized

bool casadi::GlobalOptions::julia_initialized = false

static

Definition at line 73 of file global_options.hpp.

Referenced by casadi::MadnlpInterface::init().

max_num_dir

casadi_int casadi::GlobalOptions::max_num_dir = 64

static

Definition at line 69 of file global_options.hpp.

simplification_on_the_fly

bool casadi::GlobalOptions::simplification_on_the_fly = true

static

e.g. cos(-x) -> cos(x) Default: true

Extra doc: https://github.com/casadi/casadi/wiki/L_17v

Definition at line 61 of file global_options.hpp.

Referenced by casadi::MXNode::_get_binary(), casadi::BinaryMX< ScX, ScY >::_get_binary(), casadi::SXElem::binary(), casadi::MXNode::get_horzsplit(), casadi::UnaryMX::get_unary(), casadi::MXNode::get_vertsplit(), and casadi::SXElem::unary().

start_index

casadi_int casadi::GlobalOptions::start_index = 0

static

Definition at line 71 of file global_options.hpp.

Referenced by casadi::OptiNode::g_describe(), casadi::BonminInterface::init(), casadi::report_issue(), casadi::SparsityInternal::repr_el(), casadi::OptiNode::show_infeasibilities(), and casadi::OptiNode::x_describe().

---

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

• global_options.hpp
• global_options.cpp