-
#include "tensorstore/index_interval.h"
-
Result<std::pair<OptionallyImplicitIndexInterval, Index>>
tensorstore::ExtractClosedStridedSlice(
OptionallyImplicitIndexInterval orig,
Index start,
Index stop,
Index stride); Extracts a strided closed interval from a containing interval.
This function is primarily for use by
DimExpression::ClosedInterval
.The precise definition is as follows:
Sets
adjusted_start
toorig.interval.inclusive_min()
ifstride > 0
, ororig.interval.inclusive_max()
otherwise.Sets
implicit_lower = orig.implicit_lower()
.
Otherwise (if
start != kImplicit
):Sets
adjusted_start = start
.Sets
implicit_lower = false
.
Sets
adjusted_stop
toorig.interval.inclusive_min()
ifstride < 0
, ororig.interval.inclusive_max()
otherwise.Sets
implicit_upper = orig.implicit_upper()
.
Otherwise (if
stop != kImplicit
):Sets
adjusted_stop = stop
.Sets
implicit_upper = false
.
If
stride > 0
:Sets
adjusted_interval
to[adjusted_start, adjusted_stop]
.
Otherwise (if
stride < 0
):Sets
adjusted_interval
to[adjusted_stop, adjusted_start]
.Swaps
implicit_lower
andimplicit_upper
.
Sets
new_inclusive_min = adjusted_start / stride
(rounding towards zero).If
adjusted_stop * sign(stride) == kInfIndex
:Sets
new_size = kInfIndex + 1 - new_inclusive_min
.
Otherwise:
Sets
new_size
to the maximum positive integer such thatadjusted_start + stride * (new_size - 1)
is contained inadjusted_interval
.
Sets
new_interval
to be the interval starting atnew_inclusive_min
with a size ofnew_size
.Example
If
orig = [5, 10]
,start = 6
,stop = 9
, andstride = 1
, returns[6, 9]
withadjusted_start = 6
.If
orig = [5, 10]
,start = 9
,stop = 6
, andstride = -2
, returns[-4, -3]
withadjusted_start = 9
.- Parameters:¶
- OptionallyImplicitIndexInterval orig¶
The original interval from which to extract a strided slice.
- Index start¶
The index within
orig
corresponding to the inclusive_min value in the result interval. If equal tokImplicit
, the lower (ifstride > 0
) or upper (ifstride < 0
) bound oforig
is used.- Index stop¶
Specifies the inclusive stop index within
orig
. If equal tokImplicit
, the upper (ifstride > 0
) or lower (ifstride < 0
) bound oforig
is used.- Index stride¶
Specifies the stride value.
- Returns:¶
{{new_interval, implicit_lower, implicit_upper}, adjusted_start}
- Error absl::StatusCode::kInvalidArgument:¶
if
stride == 0
orstride == std::numeric_limits<Index>::min()
.- Error absl::StatusCode::kInvalidArgument:¶
if
adjusted_interval
is not a valid interval.- Error absl::StatusCode::kOutOfRange:¶
if
adjusted_interval
is not contained withinorig
(implicit bounds oforig
do not constrainadjusted_interval
).