Class
YieldMat

Implements the YIELDMAT financial function, which calculates the annual yield for a security that pays interest at maturity.

Definition

Constructors

YieldMat()

Initializes a new YIELDMAT function instance for calculating annual yield on securities that pay all interest at maturity.

Declaration

cs-api-definition
public YieldMat()

Fields

FunctionName

The name of the function.

Declaration

cs-api-definition
public static readonly string FunctionName

Field Value

string

Properties

ArgumentConversionRules

Specifies the conversion rules applied to function arguments, excluding boolean-to-number conversions for financial calculations.

Declaration

cs-api-definition
public override ArgumentConversionRules ArgumentConversionRules { get; }

Property Value

ArgumentConversionRules

The argument conversion rules as ArgumentConversionRules.

Overrides NumbersInFunction.ArgumentConversionRules

FunctionInfo

Provides metadata describing the function's category, arguments, and help documentation.

Declaration

cs-api-definition
public override FunctionInfo FunctionInfo { get; }

Property Value

FunctionInfo

The function info as FunctionInfo.

Overrides FunctionBase.FunctionInfo

Name

Returns the function name "YIELDMAT" used in formulas.

Declaration

cs-api-definition
public override string Name { get; }

Property Value

string

The name as String.

Overrides FunctionBase.Name

Methods

EvaluateOverride(FunctionEvaluationContext<double>)

Evaluates the YIELDMAT function using the provided settlement date, maturity, issue date, interest rate, price, and optional basis, returning the annual yield as a numeric expression or an error.

Declaration

cs-api-definition
protected override RadExpression EvaluateOverride(FunctionEvaluationContext<double> context)

Parameters

context

FunctionEvaluationContext<double>

The context.

Returns

RadExpression

Functions result as RadExpression.

Overrides FunctionWithSameTypeArguments<double>.EvaluateOverride(FunctionEvaluationContext<double>)