KSLCore/ksl.utilities.rootfinding/RootFinder

RootFinder

abstract class RootFinder(aFunction: FunctionIfc, anInterval: Interval, anInitialPoint: Double = (anInterval.lowerLimit + anInterval.upperLimit) / 2.0, maxIter: Int = 100, desiredPrec: Double = KSLMath.defaultNumericalPrecision) : FunctionalIterator

Parameters

func

the function to search. The function must contain a root in the interval

anInterval

the interval to search

anInitialPoint

the initial point for the search, defaults to mid-point of the interval

maxIter

the maximum number of iterations allowed for the search, default = 100

desiredPrec

the desired precision of the search, default is KSLMath.defaultNumericalPrecision

Inheritors

BisectionRootFinder

Constructors

constructor(aFunction: FunctionIfc, anInterval: Interval, anInitialPoint: Double = (anInterval.lowerLimit + anInterval.upperLimit) / 2.0, maxIter: Int = 100, desiredPrec: Double = KSLMath.defaultNumericalPrecision)

Types

object Companion

Properties

achievedPrecision

var achievedPrecision: Double

The achieved precision.

desiredPrecision

var desiredPrecision: Double

Desired precision.

var func: FunctionIfc

var initialPoint: Double

The initial point for the search

intervalLowerLimit

val intervalLowerLimit: Double

The lower limit for the search interval

intervalUpperLimit

val intervalUpperLimit: Double

The upper limit for the search interval

iterationsExecuted

var iterationsExecuted: Int

Number of iterations performed.

maximumIterations

var maximumIterations: Int

Maximum allowed number of iterations.

var result: Double

Returns the result (assuming convergence has been attained).

Functions

operator fun contains(x: Double): Boolean

Checks to see if the supplied point is within the search interval

Performs the iterative process. Note: this method does not return anything Subclass must implement a method to get the result

fun hasConverged(): Boolean

Check to see if the result has been attained.

fun hasRoot(interval: Interval): Boolean

fun hasRoot(xLower: Double, xUpper: Double): Boolean

Returns true if the supplied interval contains a root

relativePrecision

fun relativePrecision(epsilon: Double, x: Double): Double

fun relativePrecision(epsilon: Double): Double

fun setUpSearch(aFunction: FunctionIfc, anInterval: Interval, anInitialPoint: Double = (anInterval.lowerLimit + anInterval.upperLimit) / 2.0)

The interval must have a root for the function and the initial point must be within the interval

open override fun toString(): String