package scipy

  1. Overview
  2. Docs
package scipy
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Optimize.RootResultsSource

Sourcetype tag = [
  1. | `RootResults
]
Sourcetype t = [ `Object | `RootResults ] Obj.t
Sourceval of_pyobject : Py.Object.t -> t
Sourceval to_pyobject : [> tag ] Obj.t -> Py.Object.t
Sourceval create : root:Py.Object.t -> iterations:Py.Object.t -> function_calls:Py.Object.t -> flag:Py.Object.t -> unit -> t

Represents the root finding result.

Attributes ---------- root : float Estimated root location. iterations : int Number of iterations needed to find the root. function_calls : int Number of times the function was called. converged : bool True if the routine converged. flag : str Description of the cause of termination.

Sourceval root : t -> float

Attribute root: get value or raise Not_found if None.

Sourceval root_opt : t -> float option

Attribute root: get value as an option.

Sourceval iterations : t -> int

Attribute iterations: get value or raise Not_found if None.

Sourceval iterations_opt : t -> int option

Attribute iterations: get value as an option.

Sourceval function_calls : t -> int

Attribute function_calls: get value or raise Not_found if None.

Sourceval function_calls_opt : t -> int option

Attribute function_calls: get value as an option.

Sourceval converged : t -> bool

Attribute converged: get value or raise Not_found if None.

Sourceval converged_opt : t -> bool option

Attribute converged: get value as an option.

Sourceval flag : t -> string

Attribute flag: get value or raise Not_found if None.

Sourceval flag_opt : t -> string option

Attribute flag: get value as an option.

Sourceval to_string : t -> string

Print the object to a human-readable representation.

Sourceval show : t -> string

Print the object to a human-readable representation.

Sourceval pp : Format.formatter -> t -> unit

Pretty-print the object to a formatter.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct