Struct NoisePoint

A system description at a data point in a Noise simulation.

Implements

IEquatable<NoisePoint>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public readonly struct NoisePoint : IEquatable<NoisePoint>

Constructors

NoisePoint(double, double)

Initializes a new instance of the NoisePoint struct.

Declaration

public NoisePoint(double frequency, double inverseGainSquared)

Parameters

Type	Name	Description
double	frequency	The frequency.
double	inverseGainSquared	The inverse gain squared from input to output.

Properties

Frequency

Gets the frequency.

Declaration

public double Frequency { get; }

Property Value

Type	Description
double	The frequency.

InverseGainSquared

Gets the inverse gain squared from input to output.

Declaration

public double InverseGainSquared { get; }

Property Value

Type	Description
double	The inverse gain squared.

Remarks

You can use this scaling factor to scale an output noise density to an input noise density.

LogFrequency

Gets the natural logarithm of the frequency.

Declaration

public double LogFrequency { get; }

Property Value

Type	Description
double	The natural logarithm of the frequency.

LogInverseGainSquared

Gets the natural logarithm of the inverse gain squared.

Declaration

public double LogInverseGainSquared { get; }

Property Value

Type	Description
double	The natural logarithm of the inverse gain squared.

Methods

Equals(NoisePoint)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(NoisePoint other)

Parameters

Type	Name	Description
NoisePoint	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object, is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

Operators

operator ==(NoisePoint, NoisePoint)

Implements the operator ==.

Declaration

public static bool operator ==(NoisePoint left, NoisePoint right)

Parameters

Type	Name	Description
NoisePoint	left	The left.
NoisePoint	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(NoisePoint, NoisePoint)

Implements the operator !=.

Declaration

public static bool operator !=(NoisePoint left, NoisePoint right)

Parameters

Type	Name	Description
NoisePoint	left	The left.
NoisePoint	right	The right.

Returns

Type	Description
bool	The result of the operator.

Implements

IEquatable<T>

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

IEquatable<T>