File: args_regularity_evaluation.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,192 kB
  • sloc: ansic: 76,883; sh: 82; python: 32; makefile: 13
file content (32 lines) | stat: -rw-r--r-- 1,191 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/high_level_UI.R
\name{args_regularity_evaluation}
\alias{args_regularity_evaluation}
\title{Evaluate if the arguments are regular for hyperslab use}
\usage{
args_regularity_evaluation(args, ds_dims, envir, post_read = TRUE)
}
\arguments{
\item{args}{The arguments input; if it was empty, then set to NULL}

\item{ds_dims}{The dimensions of the input dataset}

\item{envir}{The environment in which to evaluate the arguments}

\item{post_read}{Should the reshuffle be computed for post-read (then \code{TRUE}) or pre-write (then \code{FALSE})}
}
\value{
A list with 2 parts; Evaluated arguments, regularity report and reshuffle indicators. Will be returned as a list
with components \code{args_in}, \code{args_point}, \code{is_hyperslab}, \code{hyperslab},
\code{needs_reshuffle}, code{reshuffle}, \code{result_dims_pre_shuffle}, \code{result_dims_post_shuffle}, \code{max_dims}
}
\description{
Evaluate if the arguments are regular for hyperslab use
}
\details{
For each argument check if it can be used as a hyperslab, potentially after sorting and making unique.
}
\author{
Holger Hoefling
}
\keyword{internal}