ReFRACtor
nlls_problem_scaled.h
Go to the documentation of this file.
1 #ifndef NLLS_PROBLEM_SCALEDH
2 #define NLLS_PROBLEM_SCALEDH
3 #include <nlls_problem.h>
4 #include <boost/shared_ptr.hpp>
5 
6 namespace FullPhysics {
7 /******************************************************************
8  The main function of this class is to scale the parameter
9  space of a NLLS problem to be solved. Currently only a
10  diagonal scaling matrix is supported.
11 *******************************************************************/
12 class NLLSProblemScaled :
13  public NLLSProblem {
14 
15 public:
16 
17 //-----------------------------------------------------------------------
19 //-----------------------------------------------------------------------
20 
21  NLLSProblemScaled( const blitz::Array<double, 1>& s,
22  const boost::shared_ptr<NLLSProblem>& p );
23 
24  virtual ~NLLSProblemScaled() {}
25 
26 //-----------------------------------------------------------------------
31 //-----------------------------------------------------------------------
32 
33  virtual blitz::Array<double, 1> residual();
34 
35 //-----------------------------------------------------------------------
40 //-----------------------------------------------------------------------
41 
42  virtual blitz::Array<double, 2> jacobian();
43 
44 
45  virtual int residual_size() const
46  { return P->residual_size(); }
47 
48 
49 //-----------------------------------------------------------------------
51 //-----------------------------------------------------------------------
52 
53  virtual int expected_parameter_size() const
54  { return P->expected_parameter_size(); }
55 
56 
57 //-----------------------------------------------------------------------
68 //-----------------------------------------------------------------------
69 
70  virtual blitz::Array<double, 1> scale_parameters(const blitz::Array<double, 1>& x) const;
71 
72 
73 //-----------------------------------------------------------------------
77 //-----------------------------------------------------------------------
78 
79  virtual blitz::Array<double, 1> unscale_parameters(const blitz::Array<double, 1>& x) const;
80 
81 
82 //-----------------------------------------------------------------------
86 //-----------------------------------------------------------------------
87 
88  virtual void parameters(const blitz::Array<double, 1>& x);
89 
90 
91 //-----------------------------------------------------------------------
98 //-----------------------------------------------------------------------
99 
100  virtual blitz::Array<double, 1> parameters() const
101  { return NLLSProblem::parameters(); }
102 
103 
104  boost::shared_ptr<NLLSProblem> nlls_problem()
105  { return P; }
106 
107 
108 //-----------------------------------------------------------------------
110 //-----------------------------------------------------------------------
111 
112  virtual void print(std::ostream& Os) const
113  { Os << "NLLSProblemScaled"; }
114 
115 protected:
116 
117  blitz::Array<double, 1> S;
118  boost::shared_ptr<NLLSProblem> P;
119 
120 };
121 }
122 #endif
FullPhysics::NLLSProblemScaled::residual
virtual blitz::Array< double, 1 > residual()
Return the residual of the scaled NLLS problem at the current set point.
Definition: nlls_problem_scaled.cc:45
FullPhysics::NLLSProblemScaled::expected_parameter_size
virtual int expected_parameter_size() const
Return the size of the parameter X.
Definition: nlls_problem_scaled.h:53
FullPhysics::units::s
const Unit s("s", 1.0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0)
FullPhysics::NLLSProblemScaled::print
virtual void print(std::ostream &Os) const
Print description of object.
Definition: nlls_problem_scaled.h:112
FullPhysics::NLLSProblemScaled::NLLSProblemScaled
NLLSProblemScaled(const blitz::Array< double, 1 > &s, const boost::shared_ptr< NLLSProblem > &p)
Default Constructor.
Definition: nlls_problem_scaled.cc:31
FullPhysics::NLLSProblemScaled::jacobian
virtual blitz::Array< double, 2 > jacobian()
Return the Jacobian of the residual of the scaled NLLS problem at the current set point...
Definition: nlls_problem_scaled.cc:65
FullPhysics::ProblemState::parameters
virtual blitz::Array< double, 1 > parameters() const
Returns the current parameters.
Definition: problem_state.h:153
FullPhysics::NLLSProblemScaled::residual_size
virtual int residual_size() const
The size of the residual returned by residual()
Definition: nlls_problem_scaled.h:45
FullPhysics::NLLSProblemScaled::parameters
virtual blitz::Array< double, 1 > parameters() const
Just returns the current values of parameters.
Definition: nlls_problem_scaled.h:100
FullPhysics::NLLSProblem
The base class for the Non-Linear Least Squares problem.
Definition: nlls_problem.h:54
FullPhysics
Contains classes to abstract away details in various Spurr Radiative Transfer software.
Definition: doxygen_python.h:1
FullPhysics::NLLSProblemScaled::nlls_problem
boost::shared_ptr< NLLSProblem > nlls_problem()
Definition: nlls_problem_scaled.h:104
FullPhysics::NLLSProblemScaled::scale_parameters
virtual blitz::Array< double, 1 > scale_parameters(const blitz::Array< double, 1 > &x) const
If x is the input to the NLLS problem that this class is trying to scale, then this method scales the...
Definition: nlls_problem_scaled.cc:87
FullPhysics::NLLSProblemScaled::P
boost::shared_ptr< NLLSProblem > P
Definition: nlls_problem_scaled.h:118
FullPhysics::NLLSProblemScaled::unscale_parameters
virtual blitz::Array< double, 1 > unscale_parameters(const blitz::Array< double, 1 > &x) const
The input is correctly scaled to be used as input to this scaled NLLS problem.
Definition: nlls_problem_scaled.cc:96
FullPhysics::NLLSProblemScaled::S
blitz::Array< double, 1 > S
Definition: nlls_problem_scaled.h:117
Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:10