mtkExpFactors-class: The 'mtkExpFactors' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkExpFactors class is a class used to manage the factors involved in a sensitivity analysis.

Class Hierarchy

Parent classes :

Direct Known Subclasses :

Constructor

mtkExpFactors

signature(expFactorsList=list())

Slots

expFactorsList:

(list) a list of mtkFactor objects.

Methods

initialize

signature(.Object="mtkExpFactors") : The initializer.

setFactors

signature(this="mtkExpFactors",aFactList="list"): Assigns a new list of mtkFactor objects.

getFactors

signature(this="mtkExpFactors"): Returns the factors as a list of mtkFactor objects.

getNames

signature(this = "mtkExpFactors"): Returns the names of the managed factors.

getFactorNames

signature(this = "mtkExpFactors"): Returns the names of the managed factors as the method getNames.

getDistributionNames

signature(this="mtkExpFactors"): Gets a list of mtkExpFactors names.

getDistributionParameters

signature(this="mtkExpFactors"): Gets the parameters.

getFeatures

signature(this = "mtkExpFactors"): Returns the features associated with the managed factors.

getDistributionNominalValues

signature(this = "mtkExpFactors"): Returns the nominal values associated with the distributions of the managed factors.

getDistributionNominalValueTypes

signature(this = "mtkExpFactors"): Returns the data type of the nominal value associated with the managed factors.

[[

signature( x = "mtkExpFactors", i="ANY" ): Extracts or replaces parts of an object of the class mtkExpFactors.

[

signature( x = "mtkExpFactors", i="ANY" ): Extracts or replaces parts of an object of class mtkExpFactors.

$

signature(x = "mtkExpFactors"): Extracts or replaces parts of an object of the class.

print

signature(x = "mtkExpFactors"): Prints information about the managed factors.

show

signature(object = "mtkExpFactors"): Displays the underlying object of the class mtkExpFactors.

Author(s)

Hervé Richard, BioSP, Inra, [e-mail], Hervé Monod and Juhui WANG, MIA-jouy, INRA

Examples

# Define the factor
	x1 <- make.mtkFactor(name="x1", distribName="unif",
		 distribPara=list(min=-pi, max=pi))
	x2 <- make.mtkFactor(name="x2", distribName="unif",
   	 	 distribPara=list(min=-pi, max=pi))
	x3 <- make.mtkFactor(name="x3", distribName="unif", 
   	  	distribPara=list(min=-pi, max=pi))

# Build an object of the "mtkExpFactors" class
	ishi.factors <- mtkExpFactors(list(x1,x2,x3))

mtk documentation built on May 2, 2019, 4:15 a.m.