SG++-Doxygen-Documentation
python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder Class Reference
Inheritance diagram for python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder:

Public Member Functions

def __init__ (self)
 
def andGetResult (self)
 
def getSimulationLearner (self)
 
def withGrid (self)
 
def withKnowledge (self, filename)
 
def withSpecification (self)
 
def withTestingDataFromUQSettingFile (self, filename)
 

Constructor & Destructor Documentation

◆ __init__()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.__init__ (   self)
Default constructor

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simlearner, and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simspecificationDescriptor.

Member Function Documentation

◆ andGetResult()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.andGetResult (   self)
Returns the simulation learner object that is
currently being constructed

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.__collectGrid(), python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.__collectLearner(), python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.__initRefinement(), and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simlearner.

◆ getSimulationLearner()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.getSimulationLearner (   self)

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simlearner.

◆ withGrid()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.withGrid (   self)

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._gridDescriptor, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._gridDescriptor, and python.uq.learner.builder.LearnerBuilder.LearnerBuilder._gridDescriptor.

◆ withKnowledge()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.withKnowledge (   self,
  filename 
)

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._gridDescriptor, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._gridDescriptor, python.uq.learner.builder.LearnerBuilder.LearnerBuilder._gridDescriptor, python.uq.learner.builder.LearnerBuilder.LearnerBuilder._learner, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simlearner, python.uq.learner.builder.LearnerBuilder.LearnerBuilder._specificationDescriptor, and python.uq.operations.sparse_grid.createGrid().

◆ withSpecification()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.withSpecification (   self)

References python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simspecificationDescriptor.

◆ withTestingDataFromUQSettingFile()

def python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder.withTestingDataFromUQSettingFile (   self,
  filename 
)
Use this file as testing data set

WARNING: this functionality is not tested

@param filename: string file name

References python.uq.learner.builder.LearnerBuilder.LearnerBuilder._learner, and python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerBuilder._simlearner.


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