Difference between revisions of "Certain"

m (adding doc status category)
m (removed doc status)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Distribution Functions]]
 
[[Category:Distribution Functions]]
−
[[Category:Doc Status C]] <!-- For Lumina use, do not change -->
 
  
−
Returns the value of U.
+
== Certain(U)==
 +
Returns the value of «U».
  
−
= Declaration =
+
[[Certain]] is considered to be a [[:Category:Distribution Functions|distribution function]] -- the distribution in which one outcome is certain.  Therefore, its return value is different depending on whether it is evaluated in [[Evaluation Modes|Mid-mode]] or [[Evaluation Modes|Sample-mode]].  In [[Mid]]-mode, «U» is returned unchanged.  In [[Sample]]-mode, the [[Run]]-index is added to «U» if not already there, so that the result is a sample (where every sample point is the same value). 
  
−
Certain( U )
+
== Examples ==
  
−
= Description =
+
When evaluated in [[Evaluation Modes|Mid-mode]]:
 +
:<code>[[Certain]]( 25 ) &rarr; 25</code>
  
−
Certain is considered to be a [[:Category:Distribution Functions|distribution function]] -- the distribution in which one outcome is certain.  Therefore, its return value is different depending on whether it is evaluated in [[Evaluation Modes|Mid-mode]] or [[Evaluation Modes|Sample-mode]].  In Mid-mode, U is returned unchanged.  In Sample-mode, the [[Run]]-index is added to U if not already there, so that the result is a sample (where every sample point is the same value). 
+
When evaluated in [[Evaluation Modes|Sample-mode]]:
 +
:<code>[[Certain]]( 25 ) &rarr; </code> [[image:Certain usage example.png]]
  
−
(new to 4.0): The introduction of Run in sample-mode is new to 4.0.
+
==See Also==
 +
* [[Evaluation Modes]]
 +
* [[Statistical functions]]
 +
* [[Statistical Functions and Importance Weighting]]

Latest revision as of 23:35, 24 March 2016


Certain(U)

Returns the value of «U».

Certain is considered to be a distribution function -- the distribution in which one outcome is certain. Therefore, its return value is different depending on whether it is evaluated in Mid-mode or Sample-mode. In Mid-mode, «U» is returned unchanged. In Sample-mode, the Run-index is added to «U» if not already there, so that the result is a sample (where every sample point is the same value).

Examples

When evaluated in Mid-mode:

Certain( 25 ) → 25

When evaluated in Sample-mode:

Certain( 25 ) → Certain usage example.png

See Also

Comments


You are not allowed to post comments.