AllowMultimodal Property

Gets or sets a value indicating whether the result of the statistical function can be multimodal.

Syntax

Visual Basic
C#

'Declaration
 
Public Property AllowMultimodal As Boolean

'Usage
 
Dim instance As ModeFunction
Dim value As Boolean
 
instance.AllowMultimodal = value
 
value = instance.AllowMultimodal

public bool AllowMultimodal {get; set;}

Property Value

true if the result of the statistical function can be multimodal; false otherwise. By default, false.

Remarks

By default, the result will be unimodal. To enable multimodal results, the AllowMultimodal property must be set to true.

In the case where AllowMultimodal is set to true, a MultimodalResultConverter must be used to display the result, which will always be an array, even if the result is not multimodal. If false and a multimodal result occurs, only one of the mode will be returned. Ex. : [1, 2, 2, 6, 6] is bimodal (2 and 6) and the function will return either 2 or 6.

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ModeFunction Class
ModeFunction Members