Class LinearSweep

A class that implements a linear sweep.

Inheritance

object

LinearSweep

Implements

IEnumerable<double>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public class LinearSweep : IEnumerable<double>, IEnumerable

Constructors

LinearSweep(double, double, double)

Initializes a new instance of the LinearSweep class.

Declaration

public LinearSweep(double initial, double final, double delta)

Parameters

Type	Name	Description
double	initial	The initial value.
double	final	The final value.
double	delta	The step size.

LinearSweep(double, double, int)

Initializes a new instance of the LinearSweep class.

Declaration

public LinearSweep(double initial, double final, int points)

Parameters

Type	Name	Description
double	initial	The initial value.
double	final	The final value.
int	points	The number of points.

Properties

Final

The final frequency of the sweep.

Declaration

[ParameterName("stop")]
[ParameterName("final")]
[ParameterInfo("The final frequency of the sweep.")]
public double Final { get; set; }

Property Value

Type	Description
double	The final frequency value.

Initial

Gets or sets the initial.

Declaration

[ParameterName("start")]
[ParameterName("initial")]
[ParameterInfo("The initial frequency of the sweep.")]
public double Initial { get; set; }

Property Value

Type	Description
double	The initial frequency value.

Points

Gets or sets the number of points.

Declaration

[GreaterThan(0)]
public int Points { get; set; }

Property Value

Type	Description
int	The number of points.

Methods

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<double> GetEnumerator()

Returns

Type	Description
IEnumerator<double>	An enumerator that can be used to iterate through the collection.

Implements

IEnumerable<T>

IEnumerable

Extension Methods

Utility.ThrowIfNull<T>(T, string)

Utility.ThrowIfEmpty<T>(IEnumerable<T>, string)

See Also

IEnumerable<T>