File: chunkGrid.Rd

package info (click to toggle)
r-bioc-delayedarray 0.24.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,480 kB
  • sloc: ansic: 727; makefile: 2
file content (61 lines) | stat: -rw-r--r-- 1,160 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
\name{chunkGrid}

\alias{class:integer_OR_NULL}
\alias{integer_OR_NULL-class}
\alias{integer_OR_NULL}

\alias{chunkdim}
\alias{chunkdim,ANY-method}
\alias{chunkdim,DelayedUnaryOp-method}
\alias{chunkdim,DelayedSubset-method}
\alias{chunkdim,DelayedAperm-method}

\alias{chunkGrid}
\alias{chunkGrid,ANY-method}

\title{chunkGrid}

\description{
  \code{chunkGrid} and \code{chunkdim} are internal generic functions not
  aimed to be used directly by the user.
}

\usage{
chunkGrid(x)
chunkdim(x)
}

\arguments{
  \item{x}{
    An array-like object.
  }
}

\details{
  Coming soon...
}

\value{
  \code{chunkGrid} returns NULL or an \link{ArrayGrid} object defining a
  grid on reference array \code{x}.

  \code{chunkdim} returns NULL or the chunk dimensions in an integer vector
  parallel to \code{dim(x)}.
}

\seealso{
  \itemize{
    \item \code{\link{defaultAutoGrid}} and family to create automatic
          grids to use for block processing of array-like objects.

    \item \link{DelayedArray} objects.

    \item \link{ArrayGrid} for the formal representation of grids and
          viewports.
  }
}

\examples{
## Coming soon...
}
\keyword{internal}