Skip to content

func

fn Fn.new #

@[inline]
fn Fn.new(f Fn) Fn

Fn.new exposes this operation as part of the public API.

fn FnFdf.new #

@[inline]
fn FnFdf.new(fn_fdf FnFdf) FnFdf

FnFdf.new exposes this operation as part of the public API.

fn FnND.new #

fn FnND.new(f MultivariateFn) FnND

FnND.new creates a multivariate function without callback parameters.

fn FnND.new_with_params #

fn FnND.new_with_params(f MultivariateFn, params []f64) FnND

FnND.new_with_params creates a multivariate function with callback parameters.

fn FnVec.new #

@[inline]
fn FnVec.new(f FnVec) FnVec

FnVec.new exposes this operation as part of the public API.

type ArbitraryFn #

type ArbitraryFn = fn (x f64, params []f64) f64

ArbitraryFn defines a public type used by this module.

type DfFn #

type DfFn = fn (x f64, params []f64) f64

DfFn defines a public type used by this module.

type FdfFn #

type FdfFn = fn (x f64, params []f64) (f64, f64)

FdfFn defines a public type used by this module.

type MultivariateFn #

type MultivariateFn = fn (x []f64, params []f64) f64

MultivariateFn defines a scalar-valued function over an n-dimensional input.

type VectorValuedFn #

type VectorValuedFn = fn (x f64, y []f64, params []f64) f64

VectorValuedFn defines a public type used by this module.

struct Fn #

struct Fn {
pub:
	f ArbitraryFn @[required]
mut:
	params []f64
}

Definition of an arbitrary function with parameters

fn (Fn) eval #

@[inline]
fn (f Fn) eval(x f64) f64

eval exposes this operation as part of the public API.

fn (Fn) safe_eval #

@[inline]
fn (f Fn) safe_eval(x f64) !f64

safe_eval exposes this operation as part of the public API.

struct FnFdf #

struct FnFdf {
pub:
	f   ?ArbitraryFn
	df  ?DfFn
	fdf ?FdfFn
mut:
	params []f64
}

Definition of an arbitrary function returning two values, r1, r2

fn (FnFdf) eval_f #

@[inline]
fn (fdf FnFdf) eval_f(x f64) ?f64

eval_f exposes this operation as part of the public API.

fn (FnFdf) eval_df #

@[inline]
fn (fdf FnFdf) eval_df(x f64) ?f64

eval_df exposes this operation as part of the public API.

fn (FnFdf) eval_f_df #

@[inline]
fn (fdf FnFdf) eval_f_df(x f64) ?(f64, f64)

eval_f_df exposes this operation as part of the public API.

struct FnND #

struct FnND {
pub:
	f MultivariateFn @[required]
mut:
	params []f64
}

FnND represents a scalar-valued multivariate function with optional parameters.

fn (FnND) parameters #

fn (f FnND) parameters() []f64

parameters returns a copy of the callback parameters.

fn (FnND) eval #

fn (f FnND) eval(x []f64) f64

eval evaluates the multivariate function.

fn (FnND) safe_eval #

fn (f FnND) safe_eval(x []f64) !f64

safe_eval returns an error when the function value is NaN or infinite.

struct FnVec #

struct FnVec {
	f VectorValuedFn @[required]
mut:
	params []f64
}

Definition of an arbitrary vector-valued function with parameters

fn (FnVec) eval #

@[inline]
fn (f FnVec) eval(x f64, y []f64) f64

eval exposes this operation as part of the public API.