category

root_finder(Function)

  • Function - Object implementing univariate_function_protocol.

Common option handling and validation for scalar root finders.

Availability:
logtalk_load(numerical_analysis(loader))
Author: Paulo Moura
Version: 1:0:0
Date: 2026-09-04
Compilation flags:
static
Implements:
public root_finder_protocol
Extends:
public options
Remarks:
(none)
Inherited public predicates:
 check_option/1  check_options/1  default_option/1  default_options/1  find_root/2  find_root/3  find_root/4  option/2  option/3  valid_option/1  valid_options/1

Public predicates

(no local declarations; see entity ancestors if any)

Protected predicates

evaluate_function/2

Evaluates the function and checks that it returns a number.

Compilation flags:
static
Template:
evaluate_function(Argument,Value)
Mode and number of proofs:
evaluate_function(+number,-number) - one_or_error
Exceptions:
The function returns a non-numeric value:
domain_error(function_value,Value)

check_bracket/3

Checks and unpacks a root bracket.

Compilation flags:
static
Template:
check_bracket(Bracket,Lower,Upper)
Mode and number of proofs:
check_bracket(+compound,-number,-number) - one_or_error
Exceptions:
Bracket is a variable:
instantiation_error
Bracket is not a valid increasing numeric bracket:
domain_error(root_bracket,Bracket)

Private predicates

(no local declarations; see entity ancestors if any)

Operators

(none)