SG++
python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor Class Reference

CGSolver Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the CG-Solver. More...

Public Member Functions

def __getattr__ (self, attr)
 Overrides built-in method if method called is not a object method of this Descriptor, most probably it's a method of LearnerBuilder so it tries to call the method from our builder. More...
 
def __init__ (self, builder)
 Constructor. More...
 
def withAccuracy (self, accuracy)
 Defines the accuracy of CG-Solver. More...
 
def withAlphaReusing (self)
 The reusage of previous alpha data in the CG iteration. More...
 
def withImax (self, imax)
 Defines the maxinmal number of iterations in CG algotihms. More...
 
def withThreshold (self, threshold)
 Defines the maximal accuracy. More...
 

Detailed Description

CGSolver Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the CG-Solver.

Constructor & Destructor Documentation

def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__init__ (   self,
  builder 
)

Constructor.

Parameters
builderLearnerBuilder which creates this Descriptor

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__builder, and python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver.

Member Function Documentation

def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__getattr__ (   self,
  attr 
)

Overrides built-in method if method called is not a object method of this Descriptor, most probably it's a method of LearnerBuilder so it tries to call the method from our builder.

Parameters
attrString for method name
Returns
: Method calling in LearnerBuilder

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.StopPolicyDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__builder, and python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver.

def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withAccuracy (   self,
  accuracy 
)

Defines the accuracy of CG-Solver.

Parameters
accuracyfloat for accuracy
Returns
: CGSolverDescriptor itself
def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withAlphaReusing (   self)

The reusage of previous alpha data in the CG iteration.

Returns
: CGSolverDescriptor itself
def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withImax (   self,
  imax 
)

Defines the maxinmal number of iterations in CG algotihms.

Parameters
imaxinteger for maximal number of iteration in CG
Returns
: CGSolverDescriptor itself
def python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withThreshold (   self,
  threshold 
)

Defines the maximal accuracy.

If the norm of the residuum falls below this threshold, stop the CG iterations

Parameters
thresholdmaximal accuracy
Returns
: CGSolverDescriptor itself

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