WPILibC++ 2027.0.0-alpha-2
Loading...
Searching...
No Matches
slp::Slice Class Reference

Represents a sequence of elements in an iterable object. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/autodiff/slice.hpp>

Public Member Functions

constexpr Slice ()=default
 Constructs a Slice.
 
constexpr Slice (slicing::none_t)
 Constructs a slice.
 
constexpr Slice (int start)
 Constructs a slice.
 
template<typename Start , typename Stop >
requires (std::same_as<Start, slicing::none_t> || std::convertible_to<Start, int>) && (std::same_as<Stop, slicing::none_t> || std::convertible_to<Stop, int>)
constexpr Slice (Start start, Stop stop)
 Constructs a slice.
 
template<typename Start , typename Stop , typename Step >
requires (std::same_as<Start, slicing::none_t> || std::convertible_to<Start, int>) && (std::same_as<Stop, slicing::none_t> || std::convertible_to<Stop, int>) && (std::same_as<Step, slicing::none_t> || std::convertible_to<Step, int>)
constexpr Slice (Start start, Stop stop, Step step)
 Constructs a slice.
 
constexpr int adjust (int length)
 Adjusts start and end slice indices assuming a sequence of the specified length.
 

Public Attributes

int start = 0
 Start index (inclusive).
 
int stop = 0
 Stop index (exclusive).
 
int step = 1
 Step.
 

Detailed Description

Represents a sequence of elements in an iterable object.

Constructor & Destructor Documentation

◆ Slice() [1/5]

slp::Slice::Slice ( )
constexprdefault

Constructs a Slice.

◆ Slice() [2/5]

slp::Slice::Slice ( slicing::none_t )
inlineconstexpr

Constructs a slice.

◆ Slice() [3/5]

slp::Slice::Slice ( int start)
inlineconstexpr

Constructs a slice.

Parameters
startSlice start index (inclusive).

◆ Slice() [4/5]

template<typename Start , typename Stop >
requires (std::same_as<Start, slicing::none_t> || std::convertible_to<Start, int>) && (std::same_as<Stop, slicing::none_t> || std::convertible_to<Stop, int>)
slp::Slice::Slice ( Start start,
Stop stop )
inlineconstexpr

Constructs a slice.

Parameters
startSlice start index (inclusive).
stopSlice stop index (exclusive).

◆ Slice() [5/5]

template<typename Start , typename Stop , typename Step >
requires (std::same_as<Start, slicing::none_t> || std::convertible_to<Start, int>) && (std::same_as<Stop, slicing::none_t> || std::convertible_to<Stop, int>) && (std::same_as<Step, slicing::none_t> || std::convertible_to<Step, int>)
slp::Slice::Slice ( Start start,
Stop stop,
Step step )
inlineconstexpr

Constructs a slice.

Parameters
startSlice start index (inclusive).
stopSlice stop index (exclusive).
stepSlice step.

Member Function Documentation

◆ adjust()

int slp::Slice::adjust ( int length)
inlineconstexpr

Adjusts start and end slice indices assuming a sequence of the specified length.

Parameters
lengthThe sequence length.
Returns
The slice length.

Member Data Documentation

◆ start

int slp::Slice::start = 0

Start index (inclusive).

◆ step

int slp::Slice::step = 1

Step.

◆ stop

int slp::Slice::stop = 0

Stop index (exclusive).


The documentation for this class was generated from the following file: