Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
std::valarray::cshift(3)      C++ Standard Libary     std::valarray::cshift(3)

NAME
       std::valarray::cshift - std::valarray::cshift

Synopsis
	  valarray<T> cshift( int count	) const;

	  Returns  a  new  valarray of the same	size with elements whose posi-
       tions are shifted
	  circularly by	count elements.	The new	position of  each  element  is
       (icount)	mod s
	  where	i is the previous position and s is size().

Parameters
	  count	- number of positions to shift the elements by

Return value
	  The resulting	valarray with circularly shifted elements.

Notes
	  The  function	can be implemented with	the return type	different from
       std::valarray.
	  In this case,	the replacement	type has the following properties:

		     * All const member	functions of  std::valarray  are  pro-
       vided.
		     *	 std::valarray,	 std::slice_array,  std::gslice_array,
       std::mask_array and
		       std::indirect_array can be  constructed	from  the  re-
       placement type.
		     *	All  functions	accepting  an  argument	 of type const
       std::valarray&
		       except begin() and end()
		       (since C++11) should also accept	the replacement	type.
		     * All functions accepting two  arguments  of  type	 const
       std::valarray&
		       should accept every combination of const	std::valarray&
       and the
		       replacement type.
		     *	The  return  type does not add more than two levels of
       template	nesting
		       over the	most deeply-nested argument type.

Example
       // Run this code

	#include <iostream>
	#include <valarray>

	int main() {
	    std::valarray<int> v{1, 2, 3, 4, 5,	6, 7, 8};

	    for	(auto const& val : v) {
		std::cout << val << " ";
	    }
	    std::cout << "\n";

	    std::valarray<int> v2 = v.cshift(2);

	    for	(auto const& val : v2) {
		std::cout << val << " ";
	    }
	    std::cout << "\n";
	}

Output:
	1 2 3 4	5 6 7 8
	3 4 5 6	7 8 1 2

See also
	  shift	zero-filling shift the elements	of the valarray
		(public	member function)

http://cppreference.com		  2022.07.31	      std::valarray::cshift(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::valarray::cshift&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help