Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeSetFaultSamplingOptions

maeSetFaultSamplingOptions(
[ ?session t_sessionName ] 
[ ?enableSampling g_enableSampling ] 
[ ?samplingMethod t_samplingMethod ] 
[ ?sampleByNumOrRatio t_sampleByNumOrRatio ] 
[ ?sampleNum t_sampleNum ] 
[ ?sampleRatio t_sampleRatio ] 
[ ?seedValue t_seedValue ] 
[ ?confidenceValue t_confidenceValue ] 
)
=> t / nil

Description

Sets the sampling options for the fault setup.

Arguments

?session t_sessionName

Name of a session.

Default: Current session

?enableSampling g_enableSampling

A Boolean value that specifies whether to enable sampling or not. Possible values are t and nil.

Default value: t

?samplingMethod t_samplingMethod

Sampling method.

Possible values:

  • "random"
  • "randomuniform"
  • "weightsorted"
  • "randomweighted"

Default value: "random"

For details on these sampling methods, see Fault Selection and Sampling in Spectre Classic Simulator, Spectre APS, Spectre X, and Spectre XPS User Guide.

?sampleByNumOrRatio t_sampleByNumOrRatio

Specifies how you want to choose samples.

Possible values:

  • "Number": Uses a specific number of faults in each sample.
  • "Ratio": Uses a percentage or ratio of the possible samples.

Default value: "Number"

?sampleNum t_sampleNum

Number of samples to be created.

Default value: "1"

Specify this argument only when ?sampleByNumOrRatio is set to "Number" and ?sampleRatio is not specified.

?sampleRatio t_sampleRatio

The ratio of the possible samples to be created. Specify a value between 0 and 100.

Default value: "1"

Specify this argument only when ?sampleByNumOrRatio is set to "Ratio" and ?sampleNum is not specified.

?seedValue t_seedValue

A seed value greater than 0.

Default value: "1"

?confidenceValue t_confidenceValue

Value for confidence interval between 0 and 100.

Default value: "97.8"

Value Returned

t

Sampling options are updated successfully.

nil

In case of an error.

Examples

The following example explains how to set sampling options for the current fault setup:

maeSetFaultSamplingOptions( ?enableSampling t ?samplingMethod "random" ?sampleByNumOrRatio "Ratio" ?sampleRatio "2" ?seedValue "12")
=> t

Related Topics

Specifying Fault Sampling Options


Return to top
 ⠀
X