std::slice

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
gcd (C++17)	lcm (C++17)
Interpolations
midpoint (C++20)	lerp (C++20)
Saturation arithmetic
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
Generic numeric operations
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
Bit operations
has_single_bit (C++20)     bit_cast (C++20) bit_ceil (C++20) bit_floor (C++20) bit_width (C++20) rotl (C++20) rotr (C++20)	popcount (C++20) countl_zero (C++20) countl_one (C++20) countr_zero (C++20) countr_one (C++20) byteswap (C++23) endian (C++20)

 

std::valarray

Member functions
valarray::valarray valarray::~valarray valarray::operator= valarray::operator[] valarray::swap valarray::size valarray::resize valarray::sum valarray::min valarray::max valarray::shift valarray::cshift valarray::apply	valarray::operator+valarray::operator-valarray::operator~valarray::operator! valarray::operator+=valarray::operator-=valarray::operator*=valarray::operator/=valarray::operator%=valarray::operator&=valarray::operator|=valarray::operator^=valarray::operator<<=valarray::operator>>=
Non-member functions
swap(std::valarray) (C++11) begin(std::valarray) (C++11)   end(std::valarray) (C++11) abs exp log log10 pow sqrt sin cos tan asin acos atan atan2 sinh cosh tanh	operator*operator/operator%operator+operator-operator^operator&operator|operator<<operator>>operator&&operator|| operator==operator!=operator<operator>operator<=operator>=
Helper classes
slice_array gslice_array indirect_array	slice gslice mask_array
Deduction guides (C++17)

 

Defined in header <valarray>
class slice;

std::slice is the selector class that identifies a subset of std::valarray similar to BLAS slice. An object of type std::slice holds three values: the starting index, the stride, and the total number of values in the subset. Objects of type std::slice can be used as indexes with valarray's operator[].

Member functions

(constructor)	constructs a slice (public member function)
startsizestride	returns the parameters of the slice (public member function)

std::slice::slice

slice( std::size_t start = 0, std::size_t size = 0, std::size_t stride = 0 );	(1)
slice( const slice& other );	(2)

Constructs a new slice.

1) Constructs a new slice with parameters start, size, stride. This slice will refer to size number of elements, each with the position:

start

start + 1*stride

...

start + (size-1)*stride

2) Constructs a copy of other.

Parameters

start	-	the position of the first element
size	-	the number of elements in the slice
stride	-	the number of positions between successive elements in the slice
other	-	another slice to copy

std::slice::start, size, stride

std::size_t start() const;	(1)
std::size_t size() const;	(2)
std::size_t stride() const;	(3)

Returns the parameters passed to the slice on construction - start, size and stride respectively.

Parameters

(none)

Return value

The parameters of the slice -- start, size and stride respectively.

Complexity

Constant.

Non-member functions

operator==(std::slice) (C++20)

checks if two slices are equal (function)

operator==(std::slice)

friend bool operator==( const slice& lhs, const slice& rhs );		(since C++20)

Checks if the parameters of lhs and rhs - start, size and stride are equal respectively.

This function is not visible to ordinary unqualified or qualified lookup, and can only be found by argument-dependent lookup when std::slice is an associated class of the arguments.

The != operator is synthesized from operator==.

Parameters

lhs, rhs

-

slices to compare

Return value

lhs.start() == rhs.start() && lhs.size() == rhs.size() && lhs.stride() == rhs.stride()

Example

Barebones valarray-backed Matrix class with a trace calculating function.

Run this code

#include <iostream>
#include <valarray>
class Matrix {
    std::valarray<int> data;
    int dim;
 public:
    Matrix(int r, int c) : data(r*c), dim(c) {}
    int& operator()(int r, int c) {return data[r*dim + c];}
    int trace() const {
        return data[std::slice(0, dim, dim+1)].sum();
    }
};
int main()
{
    Matrix m(3,3);
    int n = 0;
    for(int r=0; r<3; ++r)
       for(int c=0; c<3; ++c)
           m(r, c) = ++n;
    std::cout << "Trace of the matrix (1,2,3) (4,5,6) (7,8,9) is " << m.trace() << '\n';
}

Output:

Trace of the matrix (1,2,3) (4,5,6) (7,8,9) is 15

See also

operator[]	get/set valarray element, slice, or mask (public member function)
gslice	generalized slice of a valarray: starting index, set of lengths, set of strides (class)
slice_array	proxy to a subset of a valarray after applying a slice (class template)