diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 91ec15f..e76b63d 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-30T23:00:59","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-01T19:03:32","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 902d46f..3d08676 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,5 +1,5 @@ -API · TaylorDiff.jl

API

API for TaylorDiff.

TaylorDiff.TaylorScalar — Type
TaylorScalar{T, N}

Representation of Taylor polynomials.

Fields

  • value::NTuple{N, T}: i-th element of this stores the (i-1)-th derivative
source
TaylorDiff.TaylorScalar — Method
TaylorScalar{T, N}(x::T, d::T) where {T, N}

Construct a Taylor polynomial with zeroth and first order coefficient, acting as a seed.

source
TaylorDiff.can_taylorize — Method
TaylorDiff.can_taylor(V::Type)

Determines whether the type V is allowed as the scalar type in a Dual. By default, only <:Real types are allowed.

source
TaylorDiff.derivative — Function
derivative(f, x, l, ::Val{N})
-derivative(f!, y, x, l, ::Val{N})

Computes order-th directional derivative of f w.r.t. vector x in direction l.

source
TaylorDiff.derivative! — Function
derivative!(result, f, x, l, ::Val{N})
-derivative!(result, f!, y, x, l, ::Val{N})

In-place derivative calculation APIs. result is expected to be pre-allocated and have the same shape as y.

source
TaylorDiff.derivatives — Function
derivatives(f, x, l, ::Val{N})
-derivatives(f!, y, x, l, ::Val{N})

Computes all derivatives of f at x up to order N - 1.

source
+API · TaylorDiff.jl

API

API for TaylorDiff.

TaylorDiff.TaylorScalar — Type
TaylorScalar{T, N}

Representation of Taylor polynomials.

Fields

  • value::NTuple{N, T}: i-th element of this stores the (i-1)-th derivative
source
TaylorDiff.TaylorScalar — Method
TaylorScalar{T, N}(x::T, d::T) where {T, N}

Construct a Taylor polynomial with zeroth and first order coefficient, acting as a seed.

source
TaylorDiff.can_taylorize — Method
TaylorDiff.can_taylor(V::Type)

Determines whether the type V is allowed as the scalar type in a Dual. By default, only <:Real types are allowed.

source
TaylorDiff.derivative — Function
derivative(f, x, l, ::Val{N})
+derivative(f!, y, x, l, ::Val{N})

Computes order-th directional derivative of f w.r.t. vector x in direction l.

source
TaylorDiff.derivative! — Function
derivative!(result, f, x, l, ::Val{N})
+derivative!(result, f!, y, x, l, ::Val{N})

In-place derivative calculation APIs. result is expected to be pre-allocated and have the same shape as y.

source
TaylorDiff.derivatives — Function
derivatives(f, x, l, ::Val{N})
+derivatives(f!, y, x, l, ::Val{N})

Computes all derivatives of f at x up to order N - 1.

source
diff --git a/dev/index.html b/dev/index.html index de959e9..db57690 100644 --- a/dev/index.html +++ b/dev/index.html @@ -11,4 +11,4 @@ publisher = {GitHub}, journal = {GitHub repository}, howpublished = {\url{https://github.com/JuliaDiff/TaylorDiff.jl}} -} +}