IMP::gsl Namespace Reference

---

Detailed Description

This module wraps optimizers from the GNU Scientific Library.

Author:

Daniel Russel

Version:

1.0

Overview:

The GSL provides various general purpose optimizers which this module exposes to IMP. The most useful is probably the IMP::gsl::Simplex optimizer. Not that GSL is licensed under the GPLv3, which requires that all other software linked with it also be licensed under a GPL-compatible license.

Examples

Examples can be found on the IMP.gsl examples page.

License:

GPLv3. This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Publications:

• The GSL web site

Data Structures
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...
Functions
std::string	get_data_path (std::string file_name)
	Return the path to installed data for this module.
std::string	get_example_path (std::string file_name)
	Return the path to installed example data for this module.
std::string	get_module_name ()
const VersionInfo &	get_module_version_info ()

---

Function Documentation

std::string IMP::gsl::get_data_path

(

std::string

file_name

)

Return the path to installed data for this module.

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 tools/imppy.sh script.

std::string IMP::gsl::get_example_path

(

std::string

file_name

)

Return the path to installed example data for this module.

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 tools/imppy.sh script.