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...

Inheritance diagram for python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor:

Public Member Functions
	__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.
	__init__ (self, builder)
	Constructor.
	withAccuracy (self, accuracy)
	Defines the accuracy of CG-Solver.
	withAlphaReusing (self)
	The reusage of previous alpha data in the CG iteration.
	withImax (self, imax)
	Defines the maxinmal number of iterations in CG algotihms.
	withThreshold (self, threshold)
	Defines the maximal accuracy.

Detailed Description

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

Constructor & Destructor Documentation

__init__()

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

Constructor.

Parameters

builder

LearnerBuilder 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, python.learner.LearnerBuilder.LearnerBuilder.FoldingDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

Member Function Documentation

__getattr__()

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

attr	String 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, python.learner.LearnerBuilder.LearnerBuilder.FoldingDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver, and python.learner.LearnerBuilder.LearnerBuilder.getLearner().

withAccuracy()

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

Defines the accuracy of CG-Solver.

Parameters

accuracy

float for accuracy

Returns

: CGSolverDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withAlphaReusing()

python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withAlphaReusing

(

self

)

The reusage of previous alpha data in the CG iteration.

Returns

: CGSolverDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withImax()

python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.withImax	(		self,
			imax
	)

Defines the maxinmal number of iterations in CG algotihms.

Parameters

imax	integer for maximal number of iteration in CG

Returns

: CGSolverDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withThreshold()

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

threshold

maximal accuracy

Returns

: CGSolverDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

---

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

• datadriven/python/learner/LearnerBuilder.py