python.uq.learner.builder.GridDescriptor.GridDescriptor Class Reference

Inheritance diagram for python.uq.learner.builder.GridDescriptor.GridDescriptor:

Public Member Functions
def	__init__ (self)
def	createGrid (self)
def	fromFile (self, filename)
def	fromGrid (self, grid)
def	hasType (self, gridType)
def	isFull (self)
def	withBoundaryLevel (self, boundaryLevel)
def	withDegree (self, deg)
def	withDimension (self, dim)
def	withLevel (self, level)

Public Attributes
	level

Detailed Description

Grid Descriptor helps to implement fluid interface patter on python
it encapsulates functionality concerning creation of the grid

Constructor & Destructor Documentation

__init__()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.__init__

(

self

)

Constructor

References python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__deg, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim.

Member Function Documentation

createGrid()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.createGrid

(

self

)

Creates the specified grid

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__boundaryLevel, python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__deg, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.learner.builder.GridDescriptor.GridDescriptor.__file, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__file, python.uq.learner.builder.GridDescriptor.GridDescriptor.__full, python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid, python.uq.learner.builder.GridDescriptor.GridDescriptor.__gridType, python.uq.operations.sparse_grid.insertTruncatedBorder(), sgpp::combigrid::ExponentialNoBoundaryPermutationIterator.level, sgpp::combigrid::TensorGrid.level, sgpp::combigrid::ExponentialChebyshevPermutationIterator.level, sgpp::combigrid::ExponentialLevelorderPermutationIterator.level, python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.level, python.learner.folding.FoldingPolicy.FoldingPolicy.level, sgpp::combigrid::AbstractEvaluator< V >.level, python.uq.learner.builder.GridDescriptor.GridDescriptor.level, sgpp::combigrid::QueueEntry.level, python.learner.folding.FilesFoldingPolicy.FilesFoldingPolicy.level, and sgpp::base::HashGridPoint.level.

fromFile()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.fromFile	(		self,
			filename
	)

Indicates that grid should be restored from file
@param filename: string name of file the grid should be restored from

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__file, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__file.

fromGrid()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.fromGrid	(		self,
			grid
	)

Indicates that all grid points in grid should also be in the
new grid
@param grid:

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__boundaryLevel, python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__deg, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid, python.uq.learner.builder.GridDescriptor.GridDescriptor.__gridType, python.uq.operations.sparse_grid.getDegree(), python.uq.operations.sparse_grid.hasBorder(), sgpp::combigrid::TensorGrid.level, sgpp::combigrid::ExponentialChebyshevPermutationIterator.level, sgpp::combigrid::ExponentialLevelorderPermutationIterator.level, sgpp::combigrid::ExponentialNoBoundaryPermutationIterator.level, python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.level, python.learner.folding.FoldingPolicy.FoldingPolicy.level, sgpp::combigrid::AbstractEvaluator< V >.level, python.uq.learner.builder.GridDescriptor.GridDescriptor.level, sgpp::combigrid::QueueEntry.level, python.learner.folding.FilesFoldingPolicy.FilesFoldingPolicy.level, and sgpp::base::HashGridPoint.level.

hasType()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.hasType	(		self,
			gridType
	)

Defines the grid type
@param gridType: type of the grid

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__gridType.

isFull()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.isFull

(

self

)

Defines if a full grid should be generated

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__full.

withBoundaryLevel()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.withBoundaryLevel	(		self,
			boundaryLevel
	)

Defines the border type of the grid
@param boundaryLevel: level of the boundary

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__boundaryLevel.

withDegree()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.withDegree	(		self,
			deg
	)

Defines the polynomial degree of the basis
@param deg: degree of polynomial base as integer

References python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.__deg, python.uq.learner.builder.GridDescriptor.GridDescriptor.__deg, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg.

withDimension()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.withDimension	(		self,
			dim
	)

Defines the dimensionality of the grid
@param dim: dimensionality as integer

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim.

withLevel()

def python.uq.learner.builder.GridDescriptor.GridDescriptor.withLevel	(		self,
			level
	)

Defines the level of the grid
@param level: level as integer

References sgpp::combigrid::ExponentialChebyshevPermutationIterator.level, sgpp::combigrid::ExponentialNoBoundaryPermutationIterator.level, sgpp::combigrid::TensorGrid.level, sgpp::combigrid::ExponentialLevelorderPermutationIterator.level, python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy.level, python.learner.folding.FoldingPolicy.FoldingPolicy.level, sgpp::combigrid::AbstractEvaluator< V >.level, python.uq.learner.builder.GridDescriptor.GridDescriptor.level, sgpp::combigrid::QueueEntry.level, python.learner.folding.FilesFoldingPolicy.FilesFoldingPolicy.level, and sgpp::base::HashGridPoint.level.

Member Data Documentation

level

python.uq.learner.builder.GridDescriptor.GridDescriptor.level

Referenced by python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.__eq__(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.contains(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.containsDimx(), python.uq.learner.builder.GridDescriptor.GridDescriptor.createGrid(), python.uq.learner.builder.GridDescriptor.GridDescriptor.fromGrid(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.getLevelIndex(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.getMaxLevel(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.overlap(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.overlapDimx(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid.transformToReferenceGrid(), python.uq.manager.ASGCStatistics.ASGCStatistics.updateResults(), python.uq.learner.SimulationLearner.SimulationLearner.updateResults(), python.uq.learner.builder.GridDescriptor.GridDescriptor.withLevel(), and python.uq.learner.builder.RegressorSpecificationDescriptor.FoldingDescriptor.withLevel().

---

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

• datadriven/python/uq/learner/builder/GridDescriptor.py