Class AcceleratorValidationResult

Namespace

DotCompute.Abstractions.Validation

Assembly

DotCompute.Abstractions.dll

Validation result specifically for accelerator configurations and capabilities. This extends UnifiedValidationResult with accelerator-specific properties.

public sealed class AcceleratorValidationResult

Inheritance

object

AcceleratorValidationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AcceleratorType

Gets the accelerator type that was validated.

public AcceleratorType AcceleratorType { get; }

Property Value

AcceleratorType

DeviceIndex

Gets the device index that was validated.

public int DeviceIndex { get; }

Property Value

int

ErrorMessage

Gets the first error message if any.

public string? ErrorMessage { get; }

Property Value

string

Errors

Gets all validation errors.

public IReadOnlyList<ValidationIssue> Errors { get; }

Property Value

IReadOnlyList<ValidationIssue>

HasWarnings

Gets whether there are validation warnings.

public bool HasWarnings { get; }

Property Value

bool

Information

Gets all informational messages.

public IReadOnlyList<ValidationIssue> Information { get; }

Property Value

IReadOnlyList<ValidationIssue>

IsValid

Gets whether the accelerator configuration is valid.

public bool IsValid { get; }

Property Value

bool

PerformanceMetrics

Gets the performance metrics collected during validation.

public AcceleratorPerformanceMetrics? PerformanceMetrics { get; }

Property Value

AcceleratorPerformanceMetrics

SupportedFeatures

Gets the validated supported features if validation succeeded.

public IReadOnlyList<string> SupportedFeatures { get; }

Property Value

IReadOnlyList<string>

Timestamp

Gets the validation timestamp.

public DateTimeOffset Timestamp { get; }

Property Value

DateTimeOffset

Warnings

Gets all validation warnings.

public IReadOnlyList<ValidationIssue> Warnings { get; }

Property Value

IReadOnlyList<ValidationIssue>

Methods

Failure(IEnumerable<string>, IEnumerable<string>?, AcceleratorType, int)

Creates a failed validation result.

public static AcceleratorValidationResult Failure(IEnumerable<string> errors, IEnumerable<string>? warnings = null, AcceleratorType acceleratorType = AcceleratorType.Auto, int deviceIndex = 0)

Parameters

errors IEnumerable<string>

Validation errors.

warnings IEnumerable<string>

Optional validation warnings.

acceleratorType AcceleratorType

The accelerator type being validated.

deviceIndex int

The device index being validated.

Returns

AcceleratorValidationResult

A failed validation result.

Failure(string, AcceleratorType, int)

Creates a failed validation result from a single error.

public static AcceleratorValidationResult Failure(string errorMessage, AcceleratorType acceleratorType = AcceleratorType.Auto, int deviceIndex = 0)

Parameters

errorMessage string

The error message.

acceleratorType AcceleratorType

The accelerator type being validated.

deviceIndex int

The device index being validated.

Returns

AcceleratorValidationResult

A failed validation result.

FromAcceleratorValidationResult(AcceleratorValidationResult)

Named alternative for implicit conversion to UnifiedValidationResult (CA2225).

public static UnifiedValidationResult FromAcceleratorValidationResult(AcceleratorValidationResult result)

Parameters

result AcceleratorValidationResult

The AcceleratorValidationResult to convert.

Returns

UnifiedValidationResult

The underlying UnifiedValidationResult.

FromException(Exception, AcceleratorType, int)

Creates a validation result from an exception.

public static AcceleratorValidationResult FromException(Exception exception, AcceleratorType acceleratorType = AcceleratorType.Auto, int deviceIndex = 0)

Parameters

exception Exception

The exception that occurred during validation.

acceleratorType AcceleratorType

The accelerator type being validated.

deviceIndex int

The device index being validated.

Returns

AcceleratorValidationResult

A failed validation result.

GetErrorSummary()

Gets a summary message of all errors.

public string GetErrorSummary()

Returns

string

A formatted error summary.

GetFullSummary()

Gets a full summary of all validation issues.

public string GetFullSummary()

Returns

string

A formatted full summary.

Success(AcceleratorType, int, IReadOnlyList<string>?, AcceleratorPerformanceMetrics?)

Creates a successful validation result.

public static AcceleratorValidationResult Success(AcceleratorType acceleratorType, int deviceIndex = 0, IReadOnlyList<string>? supportedFeatures = null, AcceleratorPerformanceMetrics? performanceMetrics = null)

Parameters

acceleratorType AcceleratorType

The validated accelerator type.

deviceIndex int

The validated device index.

supportedFeatures IReadOnlyList<string>

List of supported features.

performanceMetrics AcceleratorPerformanceMetrics

Performance metrics collected during validation.

Returns

AcceleratorValidationResult

A successful validation result.

Success(IReadOnlyList<string>, AcceleratorPerformanceMetrics)

Creates a successful validation result with features and metrics.

public static AcceleratorValidationResult Success(IReadOnlyList<string> supportedFeatures, AcceleratorPerformanceMetrics performanceMetrics)

Parameters

supportedFeatures IReadOnlyList<string>

List of supported features.

performanceMetrics AcceleratorPerformanceMetrics

Performance metrics collected during validation.

Returns

AcceleratorValidationResult

A successful validation result.

ThrowIfInvalid()

Throws an exception if validation failed.

public void ThrowIfInvalid()

Exceptions

AcceleratorValidationException

Thrown when validation fails.

ToUnifiedResult()

Converts to the underlying UnifiedValidationResult.

public UnifiedValidationResult ToUnifiedResult()

Returns

UnifiedValidationResult

The underlying UnifiedValidationResult.

Operators

implicit operator UnifiedValidationResult(AcceleratorValidationResult)

Implicit conversion to UnifiedValidationResult.

public static implicit operator UnifiedValidationResult(AcceleratorValidationResult result)

Parameters

result AcceleratorValidationResult

The AcceleratorValidationResult to convert.

Returns

UnifiedValidationResult

The underlying UnifiedValidationResult.