ComplexJsonConverter<T> Class

Definition

Namespace

Bodu.Numerics.Serialization.Json

Assembly

Bodu.Numerics.Serialization.Json.dll

Package

Bodu.Numerics.Serialization.Json 1.0.0

Source

ComplexJsonConverter{T}.cs

Converts a Complex<T> to and from JSON using the policy supplied at construction.

public sealed class ComplexJsonConverter<T> : JsonConverter<Complex<T>> where T : IFloatingPointIeee754<T>

Type Parameters

T

The floating-point component type of the complex value.

Inheritance

object

JsonConverter

JsonConverter<Complex<T>>

ComplexJsonConverter<T>

Inherited Members

JsonConverter<Complex<T>>.CanConvert(Type)

JsonConverter<Complex<T>>.ReadAsPropertyName(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<Complex<T>>.WriteAsPropertyName(Utf8JsonWriter, Complex<T>, JsonSerializerOptions)

JsonConverter<Complex<T>>.HandleNull

JsonConverter<Complex<T>>.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

The converter shape is selected by NumericsJsonPolicy:

• Strict - canonical object form { "real": 3, "imaginary": 4 }; rejects duplicate properties and non-object tokens. A finite component is written as a JSON number; a non-finite component is written as one of the JSON strings "NaN", "Infinity", or "-Infinity", since JSON numbers cannot represent those values. Either representation is accepted on read.
• Lenient - same object shape as Strict, but a top-level JSON string token is accepted and routed through Parse(ReadOnlySpan<char>, IFormatProvider?) as a tolerant fallback.
• Compact - string form "<3; 4>"; reads delegate to TryParse(ReadOnlySpan<char>, IFormatProvider?, out Complex<T>) and writes call ToString(string?, IFormatProvider?) with the invariant culture.

Constructors

ComplexJsonConverter()

Initializes a new instance of the ComplexJsonConverter<T> class configured for the Strict shape.

public ComplexJsonConverter()

ComplexJsonConverter(NumericsJsonPolicy)

Initializes a new instance of the ComplexJsonConverter<T> class configured for the supplied policy.

public ComplexJsonConverter(NumericsJsonPolicy policy)

Parameters

policy NumericsJsonPolicy

The serialization policy.

Exceptions

ArgumentOutOfRangeException

policy is not a defined NumericsJsonPolicy value.

Methods

Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

Reads and converts the JSON to type Bodu.Numerics.Complex{`0}.

public override Complex<T> Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Parameters

reader Utf8JsonReader

The reader.

typeToConvert Type

The type to convert.

options JsonSerializerOptions

An object that specifies serialization options to use.

Returns

Complex<T>

The converted value.

Write(Utf8JsonWriter, Complex<T>, JsonSerializerOptions)

Writes a specified value as JSON.

public override void Write(Utf8JsonWriter writer, Complex<T> value, JsonSerializerOptions options)

Parameters

writer Utf8JsonWriter

The writer to write to.

value Complex<T>

The value to convert to JSON.

options JsonSerializerOptions

An object that specifies serialization options to use.

Applies to

Product	Versions
.NET	8, 10