package scipy

  1. Overview
  2. Docs
package scipy
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `ScalarFunction
]
type t = [ `Object | `ScalarFunction ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val create : ?epsilon:Py.Object.t -> fun_:Py.Object.t -> x0:Py.Object.t -> args:Py.Object.t -> grad:Py.Object.t -> hess:Py.Object.t -> finite_diff_rel_step:Py.Object.t -> finite_diff_bounds:Py.Object.t -> unit -> t

Scalar function and its derivatives.

This class defines a scalar function F: R^n->R and methods for computing or approximating its first and second derivatives.

Notes ----- This class implements a memoization logic. There are methods `fun`, `grad`, hess` and corresponding attributes `f`, `g` and `H`. The following things should be considered:

1. Use only public methods `fun`, `grad` and `hess`. 2. After one of the methods is called, the corresponding attribute will be set. However, a subsequent call with a different argument of *any* of the methods may overwrite the attribute.

val fun_ : x:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

None

val fun_and_grad : x:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

None

val grad : x:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

None

val hess : x:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

None

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 : Stdlib.Format.formatter -> t -> unit

Pretty-print the object to a formatter.