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

Grid Descriptor helps to implement fluid interface patter on python it encapsulates functionality concerning creation of the grid. 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 fromFile (self, filename)
 Indicates that grid should be restored from file. More...
 
def withBorder (self, type)
 Defines the border type of the grid. More...
 
def withCliques (self, cliqueSize)
 Creates a special kind of grid where every cliqueSize dimensions are complitely interconnected (building a clique in a corresponding graphical model), while the connection between cliques exist only over the level 1 functions. More...
 
def withLevel (self, level)
 Defines the level of the grid. More...
 
def withPolynomialBase (self, deg)
 Defines the polynomial base of the grid. More...
 

Detailed Description

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

Constructor & Destructor Documentation

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

Constructor.

Parameters
builderLearnerBuilder which creates this Descriptor

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__border, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__cliqueSize, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__file, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__level.

Member Function Documentation

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__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.__border, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__builder, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__cliqueSize, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__file, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__level.

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.fromFile (   self,
  filename 
)

Indicates that grid should be restored from file.

Parameters
filenameString name of file the grid should be restored from
Returns
: GridDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__file.

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.withBorder (   self,
  type 
)

Defines the border type of the grid.

Parameters
typeborder type as defin.datadriven.learner.Types.BorderTypes
Returns
: GridDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__border.

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.withCliques (   self,
  cliqueSize 
)

Creates a special kind of grid where every cliqueSize dimensions are complitely interconnected (building a clique in a corresponding graphical model), while the connection between cliques exist only over the level 1 functions.

Parameters
cliqueSizethe number of dimensions in a clique
Returns
: GridDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__cliqueSize, and python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim.

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.withLevel (   self,
  level 
)

Defines the level of the grid.

Parameters
levellevel as integer
Returns
: GridDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__level.

def python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.withPolynomialBase (   self,
  deg 
)

Defines the polynomial base of the grid.

Parameters
degdegree of polynomial base as integer
Returns
: GridDescriptor itself

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__deg.


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