IterationSettings

public sealed class IterationSettings

Namespace SharpCell · package SharpCell

Iterative calculation, Excel's "Enable iterative calculation": circular references are calculated over and over until they settle, instead of giving 0.

Constructors

IterationSettings(bool, int, double)

public IterationSettings(bool Enabled = false, int MaxIterations = 100, double MaxChange = 0.001)

Settings for iterative calculation; the defaults are Excel's, with iteration off.

Parameters

• Enabled: Whether circular references are calculated iteratively.
• MaxIterations: The most passes over a circular reference, 1 to 32,767.
• MaxChange: A circular reference has settled when no value of it changed by more than this in a pass; 0 or more.

Exceptions

• ArgumentOutOfRangeException: A limit is outside what Excel allows.

Properties

Enabled

public bool Enabled { get; }

Whether circular references are calculated iteratively.

MaxChange

public double MaxChange { get; }

A circular reference has settled when no value changed by more than this in a pass; 0.001 by default.

MaxIterations

public int MaxIterations { get; }

The most passes over a circular reference; 100 by default.

Methods

Equals(IterationSettings)

public bool Equals(IterationSettings? other)

Whether the other settings are the same.

Equals(object)

public override bool Equals(object? obj)

Whether obj is the same settings.

GetHashCode()

public override int GetHashCode()

A hash code consistent with IterationSettings.Equals.

ToString()

public override string ToString()

The settings as text, such as Enabled, 100 iterations, change 0.001.