package scipy

  1. Overview
  2. Docs
package scipy
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `RootResults
]
type t = [ `Object | `RootResults ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val 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.

val root : t -> float

Attribute root: get value or raise Not_found if None.

val root_opt : t -> float option

Attribute root: get value as an option.

val iterations : t -> int

Attribute iterations: get value or raise Not_found if None.

val iterations_opt : t -> int option

Attribute iterations: get value as an option.

val function_calls : t -> int

Attribute function_calls: get value or raise Not_found if None.

val function_calls_opt : t -> int option

Attribute function_calls: get value as an option.

val converged : t -> bool

Attribute converged: get value or raise Not_found if None.

val converged_opt : t -> bool option

Attribute converged: get value as an option.

val flag : t -> string

Attribute flag: get value or raise Not_found if None.

val flag_opt : t -> string option

Attribute flag: get value as an option.

val to_string : t -> string

Print the object to a human-readable representation.

val show : t -> string

Print the object to a human-readable representation.

val 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