IMP::gsl Namespace Reference

See IMP.gsl for more information.

Classes
class	ConjugateGradients
	A conjugate gradients optimizer taken from GSL. More...
class	GSLOptimizer
	A base class for GSL-based optimizers. More...
class	QuasiNewton
	A quasi-Newton optimizer taken from GSL. More...
class	Simplex
	A simplex optimizer taken from GSL. More...

Typedefs
typedef IMP::base::Vector < IMP::base::Pointer < GSLOptimizer > >	GSLOptimizers
typedef IMP::base::Vector < IMP::base::WeakPointer < GSLOptimizer > >	GSLOptimizersTemp

Functions
std::string	get_data_path (std::string file_name)
	Return the full path to installed data. More...
std::string	get_example_path (std::string file_name)
	Return the path to installed example data for this module. More...

Standard module methods
All IMP modules have a set of standard methods to help get information about the module and about files associated with the module.
std::string	get_module_version ()
std::string	get_module_name ()

Typedef Documentation

typedef IMP::base::Vector<IMP::base::Pointer< GSLOptimizer > > IMP::gsl::GSLOptimizers

Store a set of objects.

Definition at line 56 of file GSLOptimizer.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< GSLOptimizer > > IMP::gsl::GSLOptimizersTemp

Pass a set of objects. See GSLOptimizer

Definition at line 56 of file GSLOptimizer.h.

Function Documentation

std::string IMP::gsl::get_data_path

(

std::string

file_name

)

Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data directory of module "mymodule", do something like

std::ifstream in(IMP::mymodule::get_data_path("data_library"));

This will ensure that the code works when IMP is installed or used via the setup_environment.sh script.

std::string IMP::gsl::get_example_path

(

std::string

file_name

)

Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb located in the examples directory of the IMP::atom module, do

 IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
model));

This will ensure that the code works when IMP is installed or used via the setup_environment.sh script.