nuget server logo nuget api documents
↑

API Docs / Microsoft.VisualBasic.MachineLearning / Threshold

Threshold

Full name Microsoft.VisualBasic.MachineLearning.ComponentModel.Activations.Threshold Assembly Microsoft.VisualBasic.MachineLearning Members 6

Threshold activation function.

00 Remarks

The class represents threshold activation function with the next expression:

f(x) = 1, if x >= 0, otherwise 0

Output range of the function: [0, 1].

Functions graph:

01 Syntax

Microsoft.VisualBasic.MachineLearning.ComponentModel.Activations.Threshold

02 Methods

NameOverloadsSummary
.ctor 1 Initializes a new instance of the Threshold class.
Function 1 Calculates function value.
CalculateDerivative 1 The threshold function is not differentiable, so that this method always returns zero.
Derivative 1 Calculates function derivative (not supported).
ToString 1 Display this activation function as a text expression.

03 Properties

NameOverloadsSummary
Store 1 Gets the XML serializable data model of this threshold function.

04 Members

method .ctor #
#ctor

Initializes a new instance of the Threshold class.

method Function #
Function(Double)

Calculates function value.

Remarks

The method calculates function value at point x.

Parameters
NameTypeDescription
xDouble

Function input value.

Returns

Function output value, f(x).

method CalculateDerivative #
CalculateDerivative(Double)

The threshold function is not differentiable, so that this method always returns zero.

Parameters
NameTypeDescription
xDouble

Function input value.

Returns

Always returns 0.

method Derivative #
Derivative(Double)

Calculates function derivative (not supported).

Remarks

The method is not supported, because it is not possible to calculate derivative of the function.

Parameters
NameTypeDescription
xDouble

Input value.

Returns

Always returns 0.

method ToString #
ToString

Display this activation function as a text expression.

Returns

A text expression in format like Threshold().

property Store #
Store

Gets the XML serializable data model of this threshold function.

Returns

A ActiveFunction data model which its function name is Threshold and no argument is required.