python.uq.dists.Corr.Corr Class Reference

Inheritance diagram for python.uq.dists.Corr.Corr:

Public Member Functions
	__init__ (self, dists)
	__str__ (self)
	fromJson (cls, jsonObject)
	getBounds (self)
	getDim (self)
	getDistributions (self)
	pdf (self, x)
	rvs (self, n=1)
	toJson (self)

Detailed Description

Models the multivariate distribution of correlated

Constructor & Destructor Documentation

__init__()

python.uq.dists.Corr.Corr.__init__	(		self,
			dists
	)

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.parameters.ParameterSet.ParameterSet.__dim, python.uq.dists.Corr.Corr.__dists, python.uq.dists.J.J.__dists, and python.uq.dists.Corr.Corr.__init__().

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

Member Function Documentation

__str__()

python.uq.dists.Corr.Corr.__str__

(

self

)

References python.uq.dists.Corr.Corr.__dists, and python.uq.dists.J.J.__dists.

fromJson()

python.uq.dists.Corr.Corr.fromJson	(		cls,
			jsonObject
	)

Restores the Corr object from the json object with its
attributes.
@param jsonObject: json object
@return: the restored Corr object

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

getBounds()

python.uq.dists.Corr.Corr.getBounds

(

self

)

References python.uq.dists.Corr.Corr.__dists, and python.uq.dists.J.J.__dists.

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

getDim()

python.uq.dists.Corr.Corr.getDim

(

self

)

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, and python.uq.parameters.ParameterSet.ParameterSet.__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().

getDistributions()

python.uq.dists.Corr.Corr.getDistributions

(

self

)

References python.uq.dists.Corr.Corr.__dists, and python.uq.dists.J.J.__dists.

Referenced by python.uq.parameters.ParameterSet.ParameterSet.getIndependentJointDistribution().

pdf()

python.uq.dists.Corr.Corr.pdf	(		self,
			x
	)

When x is correlated to y, but y not to x then the joint
probability density is defined as

p(x, y) = p(x|y) * p(y)

The correlation is described as a tuple (x, (y, )).

References python.learner.LearnerBuilder.LearnerBuilder.GridDescriptor.__dim, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__dim, python.uq.dists.Corr.Corr.__dim, python.uq.dists.DataDist.DataDist.__dim, python.uq.dists.J.J.__dim, python.uq.dists.MultivariateNormal.MultivariateNormal.__dim, python.uq.learner.builder.GridDescriptor.GridDescriptor.__dim, python.uq.parameters.ParameterSet.ParameterSet.__dim, python.uq.dists.Corr.Corr.__dists, python.uq.dists.J.J.__dists, and python.uq.dists.Corr.Corr.pdf().

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

rvs()

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

References python.uq.dists.Corr.Corr.__dists, python.uq.dists.J.J.__dists, and python.uq.dists.Corr.Corr.rvs().

Referenced by python.uq.dists.Corr.Corr.rvs().

toJson()

python.uq.dists.Corr.Corr.toJson

(

self

)

Returns a string that represents the object

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

---

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

• datadriven/python/uq/dists/Corr.py