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

NAME
     std::valarray - std::valarray

Synopsis
	Defined in header <valarray>
	template< class T >
	class valarray;

	std::valarray  is  the class for representing and manipulating arrays of
     values. It
	supports element-wise mathematical operations and various forms of  gen-
     eralized
	subscript operators, slicing and indirect access.

Notes
	std::valarray and helper classes are defined to be free of certain forms
     of
	aliasing, thus allowing operations on these classes to be optimized sim-
     ilar to the
	effect	of  the keyword restrict in the C programming language. In addi-
     tion, functions
	and operators that take valarray arguments are allowed to  return  proxy
     objects to
	make it possible for the compiler to optimize an expression such as v1 =
     a * v2 +
	v3;  as  a single loop that executes v1[i] = a * v2[i] + v3[i]; avoiding
     any
	temporaries or multiple passes. However, expression templates  make  the
     same
	optimization technique available for any C++ container, and the majority
     of numeric
	libraries prefer expression templates to valarrays for flexibility. Some
     C++
	standard  library  implementations use expression templates to implement
     efficient
	operations on std::valarray (e.g. GNU libstdc++ and LLVM  libc++).  Only
     rarely are
	valarrays optimized any further, as in e.g. Intel Integrated Performance
     Primitives.

Template parameters
	T  -  the  type  of the elements. The type must meet the NumericType re-
     quirements

Member types
	Member type Definition
	value_type  T

Member functions
	constructor   constructs new numeric array
		      (public member function)
	destructor    destructs the numeric array
		      (public member function)
	operator=     assigns the contents
		      (public member function)
	operator[]    get/set valarray element, slice, or mask
		      (public member function)
	operator+
	operator-     applies a unary arithmetic operator to each element of the
     valarray
	operator~     (public member function)
	operator!
	operator+=
	operator-=
	operator*=
	operator/=
	operator%=    applies compound assignment operator to  each  element  of
     the valarray
	operator&=    (public member function)
	operator|=
	operator^=
	operator<<=
	operator>>=
	swap	      swaps with another valarray
		      (public member function)
	size	      returns the size of valarray
		      (public member function)
	resize	      changes the size of valarray
		      (public member function)
	sum	      calculates the sum of all elements
		      (public member function)
	min	      returns the smallest element
		      (public member function)
	max	      returns the largest element
		      (public member function)
	shift	      zero-filling shift the elements of the valarray
		      (public member function)
	cshift	      circular shift of the elements of the valarray
		      (public member function)
	apply	      applies a function to every element of a valarray
		      (public member function)

Non-member functions
	std::swap(std::valarray)  specializes the std::swap algorithm
	(C++11) 		  (function template)
	std::begin(std::valarray) overloads std::begin
	(C++11) 		  (function template)
	std::end(std::valarray)   specializes std::end
	(C++11) 		  (function template)
	operator+
	operator-
	operator*
	operator/
	operator%		   applies  binary  operators to each element of
     two valarrays,
	operator&		  or a valarray and a value
	operator|		  (function template)
	operator^
	operator<<
	operator>>
	operator&&
	operator||
	operator==
	operator!=
	operator<		  compares two valarrays or a  valarray  with  a
     value
	operator<=		  (function template)
	operator>
	operator>=
	abs(std::valarray)	   applies  the  function abs to each element of
     valarray
				  (function template)

Exponential functions
	exp(std::valarray)	  applies the function std::exp to each  element
     of valarray
				  (function template)
	log(std::valarray)	   applies the function std::log to each element
     of valarray
				  (function template)
				  applies the function std::log10 to  each  ele-
     ment of
	log10(std::valarray)	  valarray
				  (function template)

Power functions
				  applies the function std::pow to two valarrays
     or a
	pow(std::valarray)	  valarray and a value
				  (function template)
	sqrt(std::valarray)	  applies the function std::sqrt to each element
     of valarray
				  (function template)

Trigonometric functions
	sin(std::valarray)	   applies the function std::sin to each element
     of valarray
				  (function template)
	cos(std::valarray)	  applies the function std::cos to each  element
     of valarray
				  (function template)
	tan(std::valarray)	   applies the function std::tan to each element
     of valarray
				  (function template)
	asin(std::valarray)	  applies the function std::asin to each element
     of valarray
				  (function template)
	acos(std::valarray)	  applies the function std::acos to each element
     of valarray
				  (function template)
	atan(std::valarray)	  applies the function std::atan to each element
     of valarray
				  (function template)
	atan2(std::valarray)	  applies the function std::atan2 to a	valarray
     and a value
				  (function template)

Hyperbolic functions
	sinh(std::valarray)	  applies the function std::sinh to each element
     of valarray
				  (function template)
	cosh(std::valarray)	  applies the function std::cosh to each element
     of valarray
				  (function template)
	tanh(std::valarray)	  applies the function std::tanh to each element
     of valarray
				  (function template)

Helper classes
	slice		BLAS-like  slice  of a valarray: starting index, length,
     stride
		       (class)
	slice_array    proxy to a subset of a valarray after applying a slice
		       (class template)
		       generalized slice of a valarray: starting index,  set  of
     lengths, set
	gslice	       of strides
		       (class)
	gslice_array   proxy to a subset of a valarray after applying a gslice
		       (class template)
		       proxy  to a subset of a valarray after applying a boolean
     mask
	mask_array     operator[]
		       (class template)
	indirect_array proxy to a subset of a valarray after  applying	indirect
     operator[]
		       (class template)

	Deduction guides(since C++17)

See also
	simd		    data-parallel vector type
	(parallelism TS v2) (class template)
	simd_mask	    data-parallel type with the element type bool
	(parallelism TS v2) (class template)

http://cppreference.com 	   2024.06.10			std::valarray(3)

home | help