PiecewiseLinearFunction Class

Represents a piecewise linear function for calculating values between pivot points.

Inheritance Hierarchy

SystemObject
GSF.NumericalAnalysis.InterpolationPiecewiseLinearFunction

Namespace: GSF.NumericalAnalysis.Interpolation
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class PiecewiseLinearFunction

Public Class PiecewiseLinearFunction

public ref class PiecewiseLinearFunction

type PiecewiseLinearFunction = class end

GSF.NumericalAnalysis.Interpolation.PiecewiseLinearFunction = function();

Type.createClass(
	'GSF.NumericalAnalysis.Interpolation.PiecewiseLinearFunction');

View Source

The PiecewiseLinearFunction type exposes the following members.

Constructors

	Name	Description
	PiecewiseLinearFunction	Initializes a new instance of the PiecewiseLinearFunction class

Top

Properties

	Name	Description
	Domain	Gets the x-values of the pivot points in the piecewise linear function.
	Range	Gets the y-values of the pivot points in the piecewise linear function.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SetDomain	Sets the x-values of the pivot points in the piecewise linear function.
	SetRange	Sets the y-values of the pivot points in the piecewise linear function.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Operators

	Name	Description
	(PiecewiseLinearFunction to FuncDouble, Double)	Converts the PiecewiseLinearFunction object to a FuncT, TResult to start converting values.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

The conversion function returned by this class uses a binary search algorithm to find the appropriate line segment to use for the calculation. Therefore, the domain must be specified either in increasing or decreasing order.

Here is an example of how to use this class.

Copy

Func<double, double> piecewiseLinearFunc = new PiecewiseLinearFunction()
    .SetDomain(-1, 0, 1)
    .SetRange(0, 1, 0);

Console.WriteLine(piecewiseLinearFunc(-10));   // -9
Console.WriteLine(piecewiseLinearFunc(-1));    // 0 
Console.WriteLine(piecewiseLinearFunc(-0.5));  // 0.5
Console.WriteLine(piecewiseLinearFunc(0));     // 1
Console.WriteLine(piecewiseLinearFunc(0.5));   // 0.5
Console.WriteLine(piecewiseLinearFunc(1));     // 0
Console.WriteLine(piecewiseLinearFunc(10));    // -9

Reference

GSF.NumericalAnalysis.Interpolation Namespace