diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 01d8c70..9541668 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-04T20:37:50","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-06T18:01:35","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 618a0ad..1a896a5 100644 --- a/dev/index.html +++ b/dev/index.html @@ -210,4 +210,4 @@ [83775a58] Zlib_jll v1.2.13+0 [8e850b90] libblastrampoline_jll v5.8.0+0 [8e850ede] nghttp2_jll v1.52.0+1 - [3f19e933] p7zip_jll v17.4.0+0

You can also download the manifest file and the project file.

+ [3f19e933] p7zip_jll v17.4.0+0

You can also download the manifest file and the project file.

diff --git a/dev/preallocationtools/index.html b/dev/preallocationtools/index.html index 0c0cd5d..d4396d7 100644 --- a/dev/preallocationtools/index.html +++ b/dev/preallocationtools/index.html @@ -1,2 +1,2 @@ -API · PreallocationTools.jl
GitHub

API

PreallocationTools.DiffCache — Type

DiffCache(u::AbstractArray, N::Int = ForwardDiff.pickchunksize(length(u)); levels::Int = 1) DiffCache(u::AbstractArray; N::AbstractArray{<:Int})

Builds a DiffCache object that stores both a version of the cache for u and for the Dual version of u, allowing use of pre-cached vectors with forward-mode automatic differentiation. Supports nested AD via keyword levels or specifying an array of chunk_sizes.

source
PreallocationTools.FixedSizeDiffCache — Method

FixedSizeDiffCache(u::AbstractArray, N = Val{default_cache_size(length(u))})

Builds a FixedSizeDiffCache object that stores both a version of the cache for u and for the Dual version of u, allowing use of pre-cached vectors with forward-mode automatic differentiation.

source
PreallocationTools.GeneralLazyBufferCache — Type
b = GeneralLazyBufferCache(f=identity)

A lazily allocated buffer object. Given an array u, b[u] returns a cache object generated by f(u), but the generator is only run the first time (and all subsequent times it reuses the same cache)

Limitation

The main limitation of this method is that its return is not type-inferred, and thus it can be slower than some other preallocation techniques. However, if used correct using things like function barriers, then this is a general technique that is sufficiently fast.

source
PreallocationTools.LazyBufferCache — Type
b = LazyBufferCache(f=identity)

A lazily allocated buffer object. Given an array u, b[u] returns an array of the same type and size f(size(u)) (defaulting to the same size), which is allocated as needed and then cached within b for subsequent usage.

source
+API · PreallocationTools.jl
GitHub

API

PreallocationTools.DiffCache — Type

DiffCache(u::AbstractArray, N::Int = ForwardDiff.pickchunksize(length(u)); levels::Int = 1) DiffCache(u::AbstractArray; N::AbstractArray{<:Int})

Builds a DiffCache object that stores both a version of the cache for u and for the Dual version of u, allowing use of pre-cached vectors with forward-mode automatic differentiation. Supports nested AD via keyword levels or specifying an array of chunk_sizes.

source
PreallocationTools.FixedSizeDiffCache — Method

FixedSizeDiffCache(u::AbstractArray, N = Val{default_cache_size(length(u))})

Builds a FixedSizeDiffCache object that stores both a version of the cache for u and for the Dual version of u, allowing use of pre-cached vectors with forward-mode automatic differentiation.

source
PreallocationTools.GeneralLazyBufferCache — Type
b = GeneralLazyBufferCache(f=identity)

A lazily allocated buffer object. Given an array u, b[u] returns a cache object generated by f(u), but the generator is only run the first time (and all subsequent times it reuses the same cache)

Limitation

The main limitation of this method is that its return is not type-inferred, and thus it can be slower than some other preallocation techniques. However, if used correct using things like function barriers, then this is a general technique that is sufficiently fast.

source
PreallocationTools.LazyBufferCache — Type
b = LazyBufferCache(f=identity)

A lazily allocated buffer object. Given an array u, b[u] returns an array of the same type and size f(size(u)) (defaulting to the same size), which is allocated as needed and then cached within b for subsequent usage.

source