-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Feb 2, 2024
1 parent
66b01f2
commit cda18a6
Showing
23 changed files
with
16,453 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
```@meta | ||
CurrentModule = CellArrays | ||
``` | ||
|
||
# API reference | ||
|
||
This is the official API reference of `CellArrays`. Note that it can also be queried interactively from the [Julia REPL] using the [help mode](https://docs.julialang.org/en/v1/stdlib/REPL/#Help-mode): | ||
```julia-repl | ||
julia> using CellArrays | ||
julia>? | ||
help?> CellArrays | ||
``` | ||
|
||
|
||
## [`CellArray`](@ref) type and basic constructors | ||
```@docs | ||
CellArray | ||
``` | ||
|
||
|
||
## Convenience type aliases and constructors | ||
#### Index | ||
* [`CellArrays.CPUCellArray`](@ref) | ||
* [`CellArrays.CuCellArray`](@ref) | ||
* [`CellArrays.ROCCellArray`](@ref) | ||
|
||
#### Documentation | ||
```@autodocs | ||
Modules = [CellArrays] | ||
Order = [:type] | ||
Filter = t -> typeof(t) !== CellArray | ||
``` | ||
|
||
|
||
## Functions -- additional to standard `AbstractArray` functionality | ||
#### Index | ||
```@index | ||
Order = [:function] | ||
``` | ||
#### Documentation | ||
```@autodocs | ||
Modules = [CellArrays] | ||
Order = [:function] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API reference · CellArrays.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://omlins.github.io/CellArrays.jl/api/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.044/juliamono.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">CellArrays.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><a class="tocitem" href="../usage/">Usage</a></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">Examples</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../examples/memcopyCellArray3D/">Memory copy of <code>CuCellArray</code>s with 4x4 <code>SMatrix</code> cells</a></li><li><a class="tocitem" href="../examples/memcopyCellArray3D_ParallelStencil/">Memory copy of <code>CellArray</code>s with 4x4 cells using ParallelStencil.jl</a></li></ul></li><li class="is-active"><a class="tocitem" href>API reference</a><ul class="internal"><li><a class="tocitem" href="#[CellArray](@ref)-type-and-basic-constructors"><span><code>CellArray</code> type and basic constructors</span></a></li><li><a class="tocitem" href="#Convenience-type-aliases-and-constructors"><span>Convenience type aliases and constructors</span></a></li><li><a class="tocitem" href="#Functions-–-additional-to-standard-AbstractArray-functionality"><span>Functions – additional to standard <code>AbstractArray</code> functionality</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/omlins/CellArrays.jl/blob/main/docs/src/api.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API-reference"><a class="docs-heading-anchor" href="#API-reference">API reference</a><a id="API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-reference" title="Permalink"></a></h1><p>This is the official API reference of <code>CellArrays</code>. Note that it can also be queried interactively from the <a href="https://docs.julialang.org/en/v1/stdlib/REPL/">Julia REPL</a> using the <a href="https://docs.julialang.org/en/v1/stdlib/REPL/#Help-mode">help mode</a>:</p><pre><code class="language-julia-repl hljs">julia> using CellArrays | ||
julia>? | ||
help?> CellArrays</code></pre><h2 id="[CellArray](@ref)-type-and-basic-constructors"><a class="docs-heading-anchor" href="#[CellArray](@ref)-type-and-basic-constructors"><a href="#CellArrays.CellArray"><code>CellArray</code></a> type and basic constructors</a><a id="[CellArray](@ref)-type-and-basic-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#[CellArray](@ref)-type-and-basic-constructors" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="CellArrays.CellArray" href="#CellArrays.CellArray"><code>CellArrays.CellArray</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CellArray{T<:Cell,N,B,T_array} <: AbstractArray{T,N} where Cell <: Union{Number, SArray, FieldArray}</code></pre><p><code>N</code>-dimensional array with elements of type <code>T</code>, where <code>T</code> are <code>Cells</code> of type Number, SArray or FieldArray. <code>B</code> defines the blocklength, which refers to the amount of values of a same <code>Cell</code> field that are stored contigously (<code>B=1</code> means array of struct like storage; <code>B=prod(dims)</code> means array struct of array like storage; <code>B=0</code> is an alias for <code>B=prod(dims)</code>, enabling better peformance thanks to more specialized dispatch). <code>T_array</code> defines the array type used for storage.</p><hr/><pre><code class="nohighlight hljs">CellArray{T,N,B}(T_arraykind, undef, dims) | ||
CellArray{T,B}(T_arraykind, undef, dims) | ||
CellArray{T}(T_arraykind, undef, dims)</code></pre><p>Construct an uninitialized <code>N</code>-dimensional <code>CellArray</code> containing <code>Cells</code> of type <code>T</code> which are stored in an array of kind <code>T_arraykind</code>.</p><div class="admonition is-info"><header class="admonition-header">Performance note</header><div class="admonition-body"><p>Best performance on GPUs is in general obtained with <code>B=0</code> as set by default. <code>B=1</code> migth give better performance in certain cases. Other values of <code>B</code> do with the current implementation not lead to optimal performance on GPU.</p></div></div><p>See also: <a href="#CellArrays.CPUCellArray"><code>CPUCellArray</code></a>, <a href="@ref"><code>CuCellArray</code></a>, <a href="@ref"><code>ROCCellArray</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/omlins/CellArrays.jl/blob/350e74c512729d3b9bfee4dda2d9493ddb60b7d2/src/CellArray.jl#L12-L29">source</a></section></article><h2 id="Convenience-type-aliases-and-constructors"><a class="docs-heading-anchor" href="#Convenience-type-aliases-and-constructors">Convenience type aliases and constructors</a><a id="Convenience-type-aliases-and-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Convenience-type-aliases-and-constructors" title="Permalink"></a></h2><h4 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h4><ul><li><a href="#CellArrays.CPUCellArray"><code>CellArrays.CPUCellArray</code></a></li><li><a href="@ref"><code>CellArrays.CuCellArray</code></a></li><li><a href="@ref"><code>CellArrays.ROCCellArray</code></a></li></ul><h4 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h4><article class="docstring"><header><a class="docstring-binding" id="CellArrays.CPUCellArray" href="#CellArrays.CPUCellArray"><code>CellArrays.CPUCellArray</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CPUCellArray{T<:Cell,N,B,T_elem} <: AbstractArray{T,N} where Cell <: Union{Number, SArray, FieldArray}</code></pre><p><code>N</code>-dimensional CellArray with cells of type <code>T</code>, blocklength <code>B</code>, and <code>T_array</code> being an <code>Array</code> of element type <code>T_elem</code>: alias for <code>CellArray{T,N,B,Array{T_elem,CellArrays._N}}</code>.</p><hr/><pre><code class="nohighlight hljs">CPUCellArray{T,B}(undef, dims) | ||
CPUCellArray{T}(undef, dims)</code></pre><p>Construct an uninitialized <code>N</code>-dimensional <code>CellArray</code> containing <code>Cells</code> of type <code>T</code> which are stored in an array of kind <code>Array</code>.</p><p>See also: <a href="#CellArrays.CellArray"><code>CellArray</code></a>, <a href="@ref"><code>CuCellArray</code></a>, <a href="@ref"><code>ROCCellArray</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/omlins/CellArrays.jl/blob/350e74c512729d3b9bfee4dda2d9493ddb60b7d2/src/CellArray.jl#L93-L106">source</a></section></article><h2 id="Functions-–-additional-to-standard-AbstractArray-functionality"><a class="docs-heading-anchor" href="#Functions-–-additional-to-standard-AbstractArray-functionality">Functions – additional to standard <code>AbstractArray</code> functionality</a><a id="Functions-–-additional-to-standard-AbstractArray-functionality-1"></a><a class="docs-heading-anchor-permalink" href="#Functions-–-additional-to-standard-AbstractArray-functionality" title="Permalink"></a></h2><h4 id="Index-2"><a class="docs-heading-anchor" href="#Index-2">Index</a><a class="docs-heading-anchor-permalink" href="#Index-2" title="Permalink"></a></h4><ul><li><a href="#CellArrays.blocklength-Union{Tuple{CellArray{T, N, B, T_array}}, Tuple{T_array}, Tuple{B}, Tuple{N}, Tuple{T}} where {T, N, B, T_array}"><code>CellArrays.blocklength</code></a></li><li><a href="#CellArrays.cellsize-Tuple{AbstractArray}"><code>CellArrays.cellsize</code></a></li><li><a href="#CellArrays.field-Union{Tuple{T_array}, Tuple{N}, Tuple{T}, Tuple{CellArray{T, N, 0, T_array}, Int64}} where {T, N, T_array}"><code>CellArrays.field</code></a></li></ul><h4 id="Documentation-2"><a class="docs-heading-anchor" href="#Documentation-2">Documentation</a><a class="docs-heading-anchor-permalink" href="#Documentation-2" title="Permalink"></a></h4><article class="docstring"><header><a class="docstring-binding" id="CellArrays.blocklength-Union{Tuple{CellArray{T, N, B, T_array}}, Tuple{T_array}, Tuple{B}, Tuple{N}, Tuple{T}} where {T, N, B, T_array}" href="#CellArrays.blocklength-Union{Tuple{CellArray{T, N, B, T_array}}, Tuple{T_array}, Tuple{B}, Tuple{N}, Tuple{T}} where {T, N, B, T_array}"><code>CellArrays.blocklength</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">blocklength(A)</code></pre><p>Return the blocklength of CellArray <code>A</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/omlins/CellArrays.jl/blob/350e74c512729d3b9bfee4dda2d9493ddb60b7d2/src/CellArray.jl#L294-L298">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CellArrays.cellsize-Tuple{AbstractArray}" href="#CellArrays.cellsize-Tuple{AbstractArray}"><code>CellArrays.cellsize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">cellsize(A) | ||
cellsize(A, dim)</code></pre><p>Return a tuple containing the dimensions of <code>A</code> or return only a specific dimension, specified by <code>dim</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/omlins/CellArrays.jl/blob/350e74c512729d3b9bfee4dda2d9493ddb60b7d2/src/CellArray.jl#L284-L289">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CellArrays.field-Union{Tuple{T_array}, Tuple{N}, Tuple{T}, Tuple{CellArray{T, N, 0, T_array}, Int64}} where {T, N, T_array}" href="#CellArrays.field-Union{Tuple{T_array}, Tuple{N}, Tuple{T}, Tuple{CellArray{T, N, 0, T_array}, Int64}} where {T, N, T_array}"><code>CellArrays.field</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">field(A, indices)</code></pre><p>Return an array view of the field of CellArray <code>A</code> designated with <code>indices</code> (modifying the view will modify <code>A</code>). The view's dimensionality and size are equal to <code>A</code>'s. The operation is not supported if parameter <code>B</code> of <code>A</code> is neither <code>0</code> nor <code>1</code>.</p><p><strong>Arguments</strong></p><ul><li><code>indices::Int|NTuple{N,Int}</code>: the <code>indices</code> that designate the field in accordance with <code>A</code>'s cell type.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/omlins/CellArrays.jl/blob/350e74c512729d3b9bfee4dda2d9493ddb60b7d2/src/CellArray.jl#L302-L309">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/memcopyCellArray3D_ParallelStencil/">« Memory copy of <code>CellArray</code>s with 4x4 cells using ParallelStencil.jl</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.16 on <span class="colophon-date" title="Friday 2 February 2024 10:32">Friday 2 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.