PrimalValueAttribute Class

Supplies optional primal-input shape metadata to the AutoDiff source generator.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.10.0

public sealed class PrimalValueAttribute : Attribute

Visual Basic

Public NotInheritable Class PrimalValueAttribute
	Inherits Attribute

C++/CLI

public ref class PrimalValueAttribute sealed : public Attribute

[<SealedAttribute>]
type PrimalValueAttribute = 
    class
        inherit Attribute
    end

Inheritance: Object → Attribute → PrimalValueAttribute

Remarks

This attribute does not mark function-value output storage. Apply FunctionValueAttribute to a writable function-value output parameter.

The current generator reads Length for a selected primal variable when static shape information is useful, including supported Jacobian sweep and output-allocation paths. Supported paths may use runtime length when no static value is supplied.

Constructors

PrimalValueAttribute

Initializes a new instance of the PrimalValueAttribute class.

Properties

Length	Gets or sets an optional static element count for the selected primal input. Omitting the named argument leaves the length unspecified to the source generator.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
GetType	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
ToString	Returns a string that represents the current object. (Inherited from Object)