diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 7ff14f8..e999c43 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-16T01:02:29","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-16T08:45:37","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 410e765..3744125 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,5 +1,5 @@ -Home · BatchedTransformations.jl

BatchedTransformations

Documentation for BatchedTransformations.

BatchedTransformations.ComposedType
Composed{Outer<:Transformation,Inner<:Transformation}

A Composed contains two transformations outer and inner that are composed, where inner gets applied first, and then outer.. It can be constructed with compose(outer, inner) or outer ∘ inner, unless the compose function is overloaded for the specific types.

source
BatchedTransformations.InverseType
Inverse{T<:Transformation}

An Inverse represents a lazy inverse of a Transformation t.

inverse(t) is a lazy inverse that defaults to inv(t) when evaluated. transform(inverse(t), x) is equivalent to inverse_transform(t, x). This allows for specialized inverse transform implementations that don't require the inverse to be computed explicitly.

source
BatchedTransformations.TransformationType
Transformation

An abstract type whose concrete subtypes contain batches of transformations that can be applied to an array. A Transformation t can be applied to x with transform(t, x), t * x, and t(x).

source
BatchedTransformations.transformMethod
transform(t, x)
+Home · BatchedTransformations.jl

BatchedTransformations

Documentation for BatchedTransformations.

BatchedTransformations.ComposedType
Composed{Outer<:Transformation,Inner<:Transformation}

A Composed contains two transformations outer and inner that are composed, where inner gets applied first, and then outer.. It can be constructed with compose(outer, inner) or outer ∘ inner, unless the compose function is overloaded for the specific types.

source
BatchedTransformations.InverseType
Inverse{T<:Transformation} <: Transformation

An Inverse represents a lazy inverse of a Transformation t.

inverse(t) is a lazy inverse that defaults to inv(t) when evaluated. transform(inverse(t), x) is equivalent to inverse_transform(t, x). This allows for specialized inverse transform implementations that don't require the inverse to be computed explicitly.

source
BatchedTransformations.TransformationType
Transformation

An abstract type whose concrete subtypes contain batches of transformations that can be applied to an array. A Transformation t can be applied to x with transform(t, x), t * x, and t(x).

source
+t(x)
source
diff --git a/dev/objects.inv b/dev/objects.inv index 37f2f4c..fbfbe91 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/search_index.js b/dev/search_index.js index 8a5ec4e..64a4beb 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"","page":"Home","title":"Home","text":"CurrentModule = BatchedTransformations","category":"page"},{"location":"#BatchedTransformations","page":"Home","title":"BatchedTransformations","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for BatchedTransformations.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [BatchedTransformations]","category":"page"},{"location":"#BatchedTransformations.Composed","page":"Home","title":"BatchedTransformations.Composed","text":"Composed{Outer<:Transformation,Inner<:Transformation}\n\nA Composed contains two transformations outer and inner that are composed, where inner gets applied first, and then outer.. It can be constructed with compose(outer, inner) or outer ∘ inner, unless the compose function is overloaded for the specific types.\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.Inverse","page":"Home","title":"BatchedTransformations.Inverse","text":"Inverse{T<:Transformation}\n\nAn Inverse represents a lazy inverse of a Transformation t.\n\ninverse(t) is a lazy inverse that defaults to inv(t) when evaluated. transform(inverse(t), x) is equivalent to inverse_transform(t, x). This allows for specialized inverse transform implementations that don't require the inverse to be computed explicitly.\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.Transformation","page":"Home","title":"BatchedTransformations.Transformation","text":"Transformation\n\nAn abstract type whose concrete subtypes contain batches of transformations that can be applied to an array. A Transformation t can be applied to x with transform(t, x), t * x, and t(x).\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.compose-Tuple{Transformation, Transformation}","page":"Home","title":"BatchedTransformations.compose","text":"compose(t2, t1)\nt2 ∘ t1\n\n\n\n\n\n","category":"method"},{"location":"#BatchedTransformations.transform-Tuple{Transformation, Any}","page":"Home","title":"BatchedTransformations.transform","text":"transform(t, x)\nt * x\nt(x)\n\n\n\n\n\n","category":"method"}] +[{"location":"","page":"Home","title":"Home","text":"CurrentModule = BatchedTransformations","category":"page"},{"location":"#BatchedTransformations","page":"Home","title":"BatchedTransformations","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for BatchedTransformations.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [BatchedTransformations]","category":"page"},{"location":"#BatchedTransformations.Composed","page":"Home","title":"BatchedTransformations.Composed","text":"Composed{Outer<:Transformation,Inner<:Transformation}\n\nA Composed contains two transformations outer and inner that are composed, where inner gets applied first, and then outer.. It can be constructed with compose(outer, inner) or outer ∘ inner, unless the compose function is overloaded for the specific types.\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.Identity","page":"Home","title":"BatchedTransformations.Identity","text":"Identity <: Transformation\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.Inverse","page":"Home","title":"BatchedTransformations.Inverse","text":"Inverse{T<:Transformation} <: Transformation\n\nAn Inverse represents a lazy inverse of a Transformation t.\n\ninverse(t) is a lazy inverse that defaults to inv(t) when evaluated. transform(inverse(t), x) is equivalent to inverse_transform(t, x). This allows for specialized inverse transform implementations that don't require the inverse to be computed explicitly.\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.Transformation","page":"Home","title":"BatchedTransformations.Transformation","text":"Transformation\n\nAn abstract type whose concrete subtypes contain batches of transformations that can be applied to an array. A Transformation t can be applied to x with transform(t, x), t * x, and t(x).\n\n\n\n\n\n","category":"type"},{"location":"#BatchedTransformations.compose-Tuple{Transformation, Transformation}","page":"Home","title":"BatchedTransformations.compose","text":"compose(t2, t1)\nt2 ∘ t1\n\n\n\n\n\n","category":"method"},{"location":"#BatchedTransformations.transform-Tuple{Transformation, Any}","page":"Home","title":"BatchedTransformations.transform","text":"transform(t, x)\nt * x\nt(x)\n\n\n\n\n\n","category":"method"}] }