Mantid
Loading...
Searching...
No Matches
Namespaces | Classes | Typedefs | Enumerations | Functions
Mantid::CurveFitting Namespace Reference

Namespaces

namespace  Algorithms
 
namespace  Constraints
 
namespace  CostFunctions
 
namespace  FuncMinimisers
 
namespace  Functions
 
namespace  MSVesuvioHelper
 
namespace  MuonHelper
 
namespace  NLLS
 
namespace  ParameterEstimator
 
namespace  SpecialFunctionSupport
 

Classes

class  AugmentedLagrangianOptimizer
 Implements the Augmented Lagrangian optimization method of Birgin & Martinez. More...
 
class  ComplexMatrix
 A complex-valued matrix for linear algebra computations. More...
 
class  ComplexVector
 A complex-valued vector for linear algebra computations. More...
 
class  CrystalFieldEnergies
 CrystalFieldEnergies : Calculates crystal field energies and wave functions for rare earth ions given the field parameters. More...
 
class  EigenJacobian
 Two implementations of Jacobian. More...
 
class  EigenMatrix
 A wrapper around Eigen::Matrix. More...
 
class  EigenMatrix_View
 
class  EigenVector
 A wrapper around Eigen::Vector. More...
 
class  EigenVector_View
 
class  ExcludeRangeFinder
 ExcludeRangeFinder : Helper clss that finds if a point should be excluded from fit. More...
 
class  FitMW
 Creates FunctionDomain1D form a spectrum in a MatrixWorkspace. More...
 
class  FortranMatrix
 FortranMatrix is a wrapper template for EigenMatrix and EigenComplexMatrix to simplify porting fortran programs to C++. More...
 
class  FortranVector
 FortranVector is a wrapper template for EigenVactor and EigenComplexVector to simplify porting fortran programs to C++. More...
 
class  FunctionDomain1DSpectrumCreator
 FunctionDomain1DSpectrumCreator : More...
 
class  GeneralDomainCreator
 GeneralDomainCreator: More...
 
struct  GSL_FitData
 Various GSL specific functions used GSL specific minimizers. More...
 
class  HalfComplex
 Class for helping to read the transformed data. More...
 
class  HistogramDomainCreator
 HistogramDomainCreator: More...
 
class  IFittingAlgorithm
 A base class for fitting algorithms. More...
 
class  IMWDomainCreator
 A base class for domain creators taking 1D data from a spectrum of a matrix workspace. More...
 
class  Jacobian
 An implementation of Jacobian using std::vector. More...
 
class  JacobianImpl1
 The implementation of Jacobian. More...
 
class  LatticeDomainCreator
 LatticeDomainCreator. More...
 
class  LatticeFunction
 LatticeFunction. More...
 
class  MultiDomainCreator
 Creates a composite domain. More...
 
class  ParDomain
 An implementation of SeqDomain for parallel cost function and derivatives computation. More...
 
class  SeqDomain
 An implementation of CompositeDomain. More...
 
class  SeqDomainSpectrumCreator
 SeqDomainSpectrumCreator : More...
 
class  TableWorkspaceDomainCreator
 

Typedefs

typedef Eigen::Map< Eigen::VectorXcd, 0, dynamic_stridecomplex_vec_map_type
 
using ComplexFortranMatrix = FortranMatrix< ComplexMatrix >
 
using ComplexFortranVector = FortranVector< ComplexVector >
 
using ComplexType = std::complex< double >
 
typedef Eigen::Map< const Eigen::MatrixXd, 0, dynamic_strideconst_map_type
 
using DoubleFortranMatrix = FortranMatrix< EigenMatrix >
 
using DoubleFortranVector = FortranVector< EigenVector >
 
typedef Eigen::Stride< Eigen::Dynamic, Eigen::Dynamic > dynamic_stride
 
using IntFortranVector = FortranVector< std::vector< int > >
 
using LatticeFunction_sptr = std::shared_ptr< LatticeFunction >
 
typedef Eigen::Map< Eigen::MatrixXd, 0, dynamic_stridemap_type
 
typedef Eigen::Map< const Eigen::VectorXd, 0, dynamic_stridevec_const_map_type
 
typedef Eigen::Map< Eigen::VectorXd, 0, dynamic_stridevec_map_type
 

Enumerations

enum  OptimizerResult { Failure = -1 , Success = 1 , FTolReached = 2 , XTolReached = 3 }
 The results of the optimization. More...
 

Functions

gsl_matrix_view getGSLMatrixView (map_type &tr)
 take data from an Eigen Matrix and return a transposed a gsl view. More...
 
gsl_matrix_const_view const getGSLMatrixView_const (const map_type m)
 take data from a constEigen Matrix and return a transposed gsl view. More...
 
gsl_vector_view getGSLVectorView (vec_map_type &v)
 take data from Eigen Vector and take a gsl view More...
 
gsl_vector_const_view const getGSLVectorView_const (const vec_map_type v)
 take const data from Eigen Vector and take a gsl view More...
 
int gsl_df (const gsl_vector *x, void *params, gsl_matrix *J)
 Fit GSL derivative function wrapper. More...
 
int gsl_f (const gsl_vector *x, void *params, gsl_vector *f)
 Fit GSL function wrapper. More...
 
int gsl_fdf (const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J)
 Fit derivatives and function GSL wrapper. More...
 
std::ostream & operator<< (std::ostream &ostr, const ComplexMatrix &m)
 The << operator. Prints a matrix in rows. More...
 
MANTID_CURVEFITTING_DLL std::ostream & operator<< (std::ostream &ostr, const ComplexVector &v)
 The << operator. More...
 
std::ostream & operator<< (std::ostream &ostr, const EigenMatrix &m)
 The << operator. Prints a matrix in rows. More...
 
MANTID_CURVEFITTING_DLL std::ostream & operator<< (std::ostream &ostr, const EigenVector &v)
 The << operator. More...
 

Typedef Documentation

◆ complex_vec_map_type

typedef Eigen::Map<Eigen::VectorXcd, 0, dynamic_stride> Mantid::CurveFitting::complex_vec_map_type

Definition at line 23 of file EigenComplexVector.h.

◆ ComplexFortranMatrix

Definition at line 17 of file EigenFortranDefs.h.

◆ ComplexFortranVector

Definition at line 19 of file EigenFortranDefs.h.

◆ ComplexType

using Mantid::CurveFitting::ComplexType = typedef std::complex<double>

Definition at line 19 of file EigenComplexVector.h.

◆ const_map_type

typedef Eigen::Map<const Eigen::MatrixXd, 0, dynamic_stride> Mantid::CurveFitting::const_map_type

Definition at line 19 of file EigenMatrixView.h.

◆ DoubleFortranMatrix

Definition at line 18 of file EigenFortranDefs.h.

◆ DoubleFortranVector

Definition at line 20 of file EigenFortranDefs.h.

◆ dynamic_stride

typedef Eigen::Stride< Eigen::Dynamic, Eigen::Dynamic > Mantid::CurveFitting::dynamic_stride

Definition at line 22 of file EigenComplexVector.h.

◆ IntFortranVector

using Mantid::CurveFitting::IntFortranVector = typedef FortranVector<std::vector<int> >

Definition at line 21 of file EigenFortranDefs.h.

◆ LatticeFunction_sptr

Definition at line 49 of file LatticeFunction.h.

◆ map_type

typedef Eigen::Map<Eigen::MatrixXd, 0, dynamic_stride> Mantid::CurveFitting::map_type

Definition at line 18 of file EigenMatrixView.h.

◆ vec_const_map_type

typedef Eigen::Map<const Eigen::VectorXd, 0, dynamic_stride> Mantid::CurveFitting::vec_const_map_type

Definition at line 15 of file EigenVectorView.h.

◆ vec_map_type

typedef Eigen::Map<Eigen::VectorXd, 0, dynamic_stride> Mantid::CurveFitting::vec_map_type

Definition at line 14 of file EigenVectorView.h.

Enumeration Type Documentation

◆ OptimizerResult

The results of the optimization.

Enumerator
Failure 
Success 
FTolReached 
XTolReached 

Definition at line 19 of file AugmentedLagrangianOptimizer.h.

Function Documentation

◆ getGSLMatrixView()

gsl_matrix_view Mantid::CurveFitting::getGSLMatrixView ( map_type tr)
inline

take data from an Eigen Matrix and return a transposed a gsl view.

Definition at line 56 of file GSLFunctions.h.

Referenced by Mantid::CurveFitting::CostFunctions::CostFuncFitting::calActiveCovarianceMatrix(), and Mantid::CurveFitting::Functions::ChebfunBase::roots().

◆ getGSLMatrixView_const()

gsl_matrix_const_view const Mantid::CurveFitting::getGSLMatrixView_const ( const map_type  m)
inline

take data from a constEigen Matrix and return a transposed gsl view.

Definition at line 63 of file GSLFunctions.h.

References Mantid::Geometry::m.

Referenced by Mantid::CurveFitting::CostFunctions::CostFuncFitting::calActiveCovarianceMatrix(), and Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer::iterate().

◆ getGSLVectorView()

gsl_vector_view Mantid::CurveFitting::getGSLVectorView ( vec_map_type v)
inline

◆ getGSLVectorView_const()

gsl_vector_const_view const Mantid::CurveFitting::getGSLVectorView_const ( const vec_map_type  v)
inline

take const data from Eigen Vector and take a gsl view

Definition at line 59 of file GSLFunctions.h.

Referenced by Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer::iterate().

◆ gsl_df()

int Mantid::CurveFitting::gsl_df ( const gsl_vector *  x,
void *  params,
gsl_matrix *  J 
)

◆ gsl_f()

int Mantid::CurveFitting::gsl_f ( const gsl_vector *  x,
void *  params,
gsl_vector *  f 
)

Fit GSL function wrapper.

Parameters
x:: Input function parameters
params:: Input data
f:: Output function values = (y_cal-y_data)/sigma for each data point
Returns
A GSL status information

Definition at line 22 of file GSLFunctions.cpp.

References Mantid::API::IConstraint::checkDeriv(), Mantid::CurveFitting::GSL_FitData::function, n, and Mantid::Geometry::x.

Referenced by Mantid::CurveFitting::Algorithms::Fit1D::exec(), Mantid::CurveFitting::Algorithms::gsl_f(), Mantid::CurveFitting::Algorithms::gsl_fdf(), gsl_fdf(), and Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer::initialize().

◆ gsl_fdf()

int Mantid::CurveFitting::gsl_fdf ( const gsl_vector *  x,
void *  params,
gsl_vector *  f,
gsl_matrix *  J 
)

Fit derivatives and function GSL wrapper.

Parameters
x:: Input function arguments
params:: Input data
f:: Output function values = (y_cal-y_cal)/sigma for each data point
J:: Output derivatives
Returns
A GSL status information

Definition at line 158 of file GSLFunctions.cpp.

References gsl_df(), gsl_f(), and Mantid::Geometry::x.

Referenced by Mantid::CurveFitting::Algorithms::Fit1D::exec(), Mantid::CurveFitting::Algorithms::gsl_fdf(), and Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer::initialize().

◆ operator<<() [1/4]

std::ostream & Mantid::CurveFitting::operator<< ( std::ostream &  ostr,
const ComplexMatrix m 
)
inline

The << operator. Prints a matrix in rows.

Definition at line 130 of file EigenComplexMatrix.h.

References Mantid::Geometry::m, and value.

◆ operator<<() [2/4]

std::ostream & Mantid::CurveFitting::operator<< ( std::ostream &  ostr,
const ComplexVector v 
)

◆ operator<<() [3/4]

std::ostream & Mantid::CurveFitting::operator<< ( std::ostream &  ostr,
const EigenMatrix m 
)
inline

The << operator. Prints a matrix in rows.

Definition at line 135 of file EigenMatrix.h.

References Mantid::Geometry::m.

◆ operator<<() [4/4]

std::ostream & Mantid::CurveFitting::operator<< ( std::ostream &  ostr,
const EigenVector v 
)

The << operator.

Definition at line 282 of file EigenVector.cpp.

References Mantid::CurveFitting::EigenVector::size().