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

Public Member Functions

def __init__ (self, mu, sigma, a, b)
 
def __str__ (self)
 
def by_alpha (cls, mu, sigma, alpha)
 
def by_range (cls, args, kws)
 
def cdf (self, x)
 
def fromJson (cls, jsonObject)
 
def getBounds (self)
 
def getDim (self)
 
def mean (self)
 
def pdf (self, x)
 
def ppf (self, x)
 
def rvs (self, n=1)
 
def std (self)
 
def toJson (self)
 
def var (self)
 

Detailed Description

Represents a truncated normal distribution

See: http://en.wikipedia.org/wiki/Truncated_normal_distribution

Constructor & Destructor Documentation

◆ __init__()

def python.uq.dists.Normal.Normal.__init__ (   self,
  mu,
  sigma,
  a,
  b 
)
Constructor
@param mu: expectation value
@param sigma: standard deviation
@param a: lower boundary
@param b: upper boundary

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal.__linearTrans, python.uq.dists.Normal.Normal.__linearTrans, python.uq.dists.Lognormal.Lognormal.__mu, python.uq.dists.MultivariateNormal.MultivariateNormal.__mu, python.uq.dists.Normal.Normal.__mu, python.uq.dists.Lognormal.Lognormal.__sigma, python.uq.dists.Normal.Normal.__sigma, python.uq.dists.Lognormal.Lognormal._dist, python.uq.dists.Beta.Beta._dist, python.uq.dists.Normal.Normal._dist, python.uq.dists.Normal.Normal.cdf(), and python.convergence.norm().

Member Function Documentation

◆ __str__()

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

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal.__mu, python.uq.dists.MultivariateNormal.MultivariateNormal.__mu, python.uq.dists.Normal.Normal.__mu, python.uq.dists.Lognormal.Lognormal.__sigma, and python.uq.dists.Normal.Normal.__sigma.

◆ by_alpha()

def python.uq.dists.Normal.Normal.by_alpha (   cls,
  mu,
  sigma,
  alpha 
)
Constructor given a confidence value
@param mu: expectation value
@param sigma: standard deviation
@param alpha: confidence value

References python.convergence.norm().

◆ by_range()

def python.uq.dists.Normal.Normal.by_range (   cls,
  args,
  kws 
)
Constructor given a interval

◆ cdf()

def python.uq.dists.Normal.Normal.cdf (   self,
  x 
)

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal.__linearTrans, python.uq.dists.Normal.Normal.__linearTrans, python.uq.dists.Lognormal.Lognormal._dist, python.uq.dists.Beta.Beta._dist, and python.uq.dists.Normal.Normal._dist.

Referenced by python.uq.dists.Normal.Normal.__init__().

◆ fromJson()

def python.uq.dists.Normal.Normal.fromJson (   cls,
  jsonObject 
)
Restores the TNormal object from the json object with its
attributes.
@param jsonObject: json object
@return: the restored TNormal 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.Normal.Normal.getBounds (   self)

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, and python.uq.dists.Normal.Normal.__b.

◆ getDim()

◆ mean()

def python.uq.dists.Normal.Normal.mean (   self)

References python.uq.dists.Lognormal.Lognormal.__mu, python.uq.dists.MultivariateNormal.MultivariateNormal.__mu, and python.uq.dists.Normal.Normal.__mu.

Referenced by python.uq.analysis.mc.MCAnalysis.MCAnalysis.computeMoments(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeMoments(), and python.uq.dists.SGDEdist.SGDEdist.var().

◆ pdf()

def python.uq.dists.Normal.Normal.pdf (   self,
  x 
)

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal._dist, python.uq.dists.Beta.Beta._dist, and python.uq.dists.Normal.Normal._dist.

◆ ppf()

def python.uq.dists.Normal.Normal.ppf (   self,
  x 
)

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal.__linearTrans, python.uq.dists.Normal.Normal.__linearTrans, python.uq.dists.Lognormal.Lognormal._dist, python.uq.dists.Beta.Beta._dist, and python.uq.dists.Normal.Normal._dist.

Referenced by python.uq.dists.EstimatedDist.EstimatedDist.rvs(), and python.uq.dists.SGDEdist.SGDEdist.rvs().

◆ rvs()

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

References python.uq.dists.Lognormal.Lognormal.__a, python.uq.transformation.LinearTransformation.LinearTransformation.__a, python.uq.dists.Uniform.Uniform.__a, python.uq.dists.Lognormal.Lognormal.__b, python.uq.dists.MultivariateNormal.MultivariateNormal.__b, python.uq.dists.Normal.Normal.__b, python.uq.dists.Lognormal.Lognormal._dist, python.uq.dists.Beta.Beta._dist, and python.uq.dists.Normal.Normal._dist.

◆ std()

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

References python.uq.dists.Lognormal.Lognormal.__sigma, and python.uq.dists.Normal.Normal.__sigma.

◆ toJson()

◆ var()

def python.uq.dists.Normal.Normal.var (   self)

References python.uq.dists.Lognormal.Lognormal.__sigma, and python.uq.dists.Normal.Normal.__sigma.

Referenced by python.uq.analysis.mc.MCAnalysis.MCAnalysis.computeMoments(), and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeMoments().


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