Set@Input

From COSSAN Wiki
Jump to: navigation, search
Outdated.png This article's factual accuracy may be compromised because of out-of-date information. Please help improve the article by updating it.
This feature has been discontinued


Description

SET method is used to change thy property of an object (i.e. Parameter, RandomVariable, Function) included in the Input Object.

Input Arguments

Name
Type
required
description
SobjectName or Sname string yes Name of the object to be modified
SpropertyName string yes Property Name of the object to be modified
value or Vvalues double or array yes if SobjectName is defined Property Name of the object to be modified
Msamples array - Replace the samples in the Samples object
Tsamples structure - Replace the samples in the Samples object
Xsamples [[@Samples] - Replace the Samples object

SpropertyName

Name Required  ObjectType description
mean RandomVariable change the mean 
std RandomVariable change the standard deviation 
variance RandomVariable change the variance
parameter1 RandomVariable change the value of the first parameter that define the distribution of the RandomVariables  
parameter2 RandomVariable change the value of the second parameter that define the distribution of the RandomVariables 
parameter3 RandomVariable change the value of the third parameter that define the distribution of the RandomVariables 
parameter4 RandomVariable change the value of the forth parameter that define the distribution of the RandomVariables 
parametervalue Parameter change the value of the parameter
designvariablevalue DesignVariable change the current value of the DesignVariable
lowerBound DesignVariable change the lower bound of the DesignVariable
upperBound DesignVariable change the upper bound of the DesignVariable
Vsupport DesignVariable change the support point of the DesignVariable

Important.png SpropertyName is case sensitive
It is strictly necessary to pass the PropertyName is the exact capital and lowercase letters


Output Arguments

The set method returns the modified Input object.

Usage

   Xinput=Xinput.set('SobjectName','Xrv1','SpropertyName,'mean','value',2);

where Xrv1 is the name of a RandomVariable present in the Input object.

See Also