SG++-Doxygen-Documentation
python.uq.dists.DataDist.DataDist Class Reference
Inheritance diagram for python.uq.dists.DataDist.DataDist:

Public Member Functions

def __init__ (self, samples, bounds=None)
 
def __str__ (self)
 
def cdf (self, p, args, kws)
 
def fromJson (cls, jsonObject)
 
def getBounds (self)
 
def getDim (self)
 
def mean (self)
 
def pdf (self, p, args, kws)
 
def ppf (self, p, args, kws)
 
def rvs (self, n=1)
 
def std (self)
 
def toJson (self)
 
def var (self)
 

Public Attributes

 samples
 

Detailed Description

Models a discrete distribution given by data

Constructor & Destructor Documentation

◆ __init__()

def python.uq.dists.DataDist.DataDist.__init__ (   self,
  samples,
  bounds = None 
)
Constructor. There are some restrictions to the samples:
As they represent the underlying probability, they have to be drawn
iid.
@param samples: numpy array (num_samples x num_dims)
@param bounds: numpy array  (num_dims x 2)

Member Function Documentation

◆ __str__()

def python.uq.dists.DataDist.DataDist.__str__ (   self)

References python.uq.dists.DataDist.DataDist.__bounds, python.uq.dists.Corr.Corr.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.transformation.JointTransformation.JointTransformation.__n, python.uq.estimators.MonteCarloStrategy.MonteCarloStrategy.__n, python.uq.dists.J.J.__n, python.uq.parameters.ParameterSet.ParameterSet.__n, and python.uq.parameters.ParameterBuilder.GeneralParameterBuilder.__n.

◆ cdf()

def python.uq.dists.DataDist.DataDist.cdf (   self,
  p,
  args,
  kws 
)

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

◆ fromJson()

def python.uq.dists.DataDist.DataDist.fromJson (   cls,
  jsonObject 
)
Restores the Beta object from the json object with its
attributes.

Arguments:
jsonObject -- json object

Return the restored UQSetting object

Referenced by python.uq.sampler.asgc.ASGCSampler.ASGCSampler.setMemento(), python.uq.learner.Learner.Learner.setMemento(), and python.uq.uq_setting.UQSetting.UQSetting.setMemento().

◆ getBounds()

def python.uq.dists.DataDist.DataDist.getBounds (   self)

References python.uq.dists.DataDist.DataDist.__bounds.

Referenced by python.uq.dists.J.J.discretize(), and python.uq.dists.Dist.Dist.l2error().

◆ getDim()

def python.uq.dists.DataDist.DataDist.getDim (   self)

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

Referenced by python.uq.dists.SGDEdist.SGDEdist.__str__(), python.uq.dists.Dist.Dist.cov(), python.uq.parameters.ParameterSet.ParameterSet.extractActiveSubset(), python.uq.dists.KDEDist.KDEDist.getBandwidths(), python.uq.dists.EstimatedDist.EstimatedDist.getBounds(), and python.uq.uq_setting.UQSetting.UQSetting.getDim().

◆ mean()

◆ pdf()

def python.uq.dists.DataDist.DataDist.pdf (   self,
  p,
  args,
  kws 
)

References python.uq.transformation.JointTransformation.JointTransformation.__n, python.uq.estimators.MonteCarloStrategy.MonteCarloStrategy.__n, python.uq.dists.J.J.__n, python.uq.parameters.ParameterSet.ParameterSet.__n, python.uq.parameters.ParameterBuilder.GeneralParameterBuilder.__n, and python.uq.dists.DataDist.DataDist.__sampleToIndex.

Referenced by python.uq.dists.Dist.Dist.crossEntropy(), python.uq.dists.J.J.discretize(), python.uq.dists.Dist.Dist.klDivergence(), and python.uq.dists.Dist.Dist.l2error().

◆ ppf()

◆ rvs()

def python.uq.dists.DataDist.DataDist.rvs (   self,
  n = 1 
)

◆ std()

def python.uq.dists.DataDist.DataDist.std (   self)

References python.uq.dists.Beta.Beta.var(), sgpp::combigrid::BsplineStochasticCollocation.var, sgpp::combigrid::PolynomialStochasticCollocation.var, python.uq.dists.DataDist.DataDist.var(), and python.uq.analysis.Analysis.Analysis.var().

◆ toJson()

def python.uq.dists.DataDist.DataDist.toJson (   self)
Returns a string that represents the object

Arguments:

Return A string that represents the object

References python.uq.dists.DataDist.DataDist.__bounds, and python.uq.dists.DataDist.DataDist.samples.

Referenced by python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__str__(), python.uq.uq_setting.UQSetting.UQSetting.__str__(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.createMemento(), and python.uq.uq_setting.UQSetting.UQSetting.createMemento().

◆ var()

Member Data Documentation

◆ samples


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