Linux Certif

Toute la documentation sur la certification Linux LPI

std::valarray

NAME

std::valarray - Smart array designed to support numeric processing.

SYNOPSIS

Public Types

typedef _Tp value_type

Public Member Functions

_Expr< _RefFunClos< _ValArray, _Tp >, _Tp > apply (_Tp func(const _Tp &)) const

_Expr< _ValFunClos< _ValArray, _Tp >, _Tp > apply (_Tp func(_Tp)) const

valarray< _Tp > cshift (int) const

_Tp max () const

_Tp min () const

_UnaryOp< __logical_not >::_Rt operator! () const

template<class _Dom > valarray< _Tp > & operator%= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator%= (const valarray< _Tp > &)

valarray< _Tp > & operator%= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator&= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator&= (const valarray< _Tp > &)

valarray< _Tp > & operator&= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator*= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator*= (const valarray< _Tp > &)

valarray< _Tp > & operator*= (const _Tp &)

_UnaryOp< __unary_plus >::_Rt operator+ () const

template<class _Dom > valarray< _Tp > & operator+= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator+= (const valarray< _Tp > &)

valarray< _Tp > & operator+= (const _Tp &)

_UnaryOp< __negate >::_Rt operator- () const

template<class _Dom > valarray< _Tp > & operator-= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator-= (const valarray< _Tp > &)

valarray< _Tp > & operator-= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator/= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator/= (const valarray< _Tp > &)

valarray< _Tp > & operator/= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator<<= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator<<= (const valarray< _Tp > &)

valarray< _Tp > & operator<<= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator= (const indirect_array< _Tp > &)

valarray< _Tp > & operator= (const mask_array< _Tp > &)

valarray< _Tp > & operator= (const gslice_array< _Tp > &)

valarray< _Tp > & operator= (const slice_array< _Tp > &)

valarray< _Tp > & operator= (const _Tp &)

valarray< _Tp > & operator= (const valarray< _Tp > &)

template<class _Dom > valarray< _Tp > & operator>>= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator>>= (const valarray< _Tp > &)

valarray< _Tp > & operator>>= (const _Tp &)

indirect_array< _Tp > operator[] (const valarray< size_t > &)

_Expr< _IClos< _ValArray, _Tp >, _Tp > operator[] (const valarray< size_t > &) const

mask_array< _Tp > operator[] (const valarray< bool > &)

valarray< _Tp > operator[] (const valarray< bool > &) const

gslice_array< _Tp > operator[] (const gslice &)

_Expr< _GClos< _ValArray, _Tp >, _Tp > operator[] (const gslice &) const

slice_array< _Tp > operator[] (slice)

_Expr< _SClos< _ValArray, _Tp >, _Tp > operator[] (slice) const

const _Tp & operator[] (size_t) const

_Tp & operator[] (size_t)

template<class _Dom > valarray< _Tp > & operator^= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator^= (const valarray< _Tp > &)

valarray< _Tp > & operator^= (const _Tp &)

template<class _Dom > valarray< _Tp > & operator|= (const _Expr< _Dom, _Tp > &)

valarray< _Tp > & operator|= (const valarray< _Tp > &)

valarray< _Tp > & operator|= (const _Tp &)

_UnaryOp< __bitwise_not >::_Rt operator~ () const

void resize (size_t __size, _Tp __c=_Tp())

valarray< _Tp > shift (int) const

size_t size () const

_Tp sum () const

template<typename _Tp> valarray (const _Tp *__restrict__ __p, size_t __n)

template<class _Dom > valarray (const _Expr< _Dom, _Tp > &__e)

valarray (const indirect_array< _Tp > &)

valarray (const mask_array< _Tp > &)

valarray (const gslice_array< _Tp > &)

valarray (const slice_array< _Tp > &)

valarray (const valarray &)

valarray (const _Tp *__restrict__, size_t)

valarray (const _Tp &, size_t)

valarray (size_t)

valarray ()

Friends

class _Array< _Tp >

Detailed Description

template<class _Tp> class std::valarray< _Tp >

A valarray is an array that provides constraints intended to allow for effective optimization of numeric array processing by reducing the aliasing that can result from pointer representations. It represents a one-dimensional array from which different multidimensional subsets can be accessed and modified.

Parameters:

Tp Type of object in the array.

Definition at line 109 of file valarray.

Constructor & Destructor Documentation

template<typename _Tp > std::valarray< _Tp >::valarray () [inline]

Construct an empty array.

Definition at line 551 of file valarray.

template<typename _Tp > std::valarray< _Tp >::valarray (size_t __n) [inline, explicit]

Construct an array with n elements.

Definition at line 555 of file valarray.

template<typename _Tp> std::valarray< _Tp >::valarray (const _Tp & __t, size_t __n) [inline]

Construct an array with n elements initialized to t.

Definition at line 561 of file valarray.

template<class _Tp> std::valarray< _Tp >::valarray (const _Tp * __restrict__, size_t)

Construct an array initialized to the first n elements of t.

template<typename _Tp> std::valarray< _Tp >::valarray (const valarray< _Tp > & __v) [inline]

Copy constructor.

Definition at line 576 of file valarray.

References std::valarray< _Tp >::_M_data.

template<typename _Tp> std::valarray< _Tp >::valarray (const slice_array< _Tp > & __sa) [inline]

Construct an array with the same size and values in sa.

Definition at line 583 of file valarray.

References std::slice_array< _Tp >::_M_array, std::slice_array< _Tp >::_M_stride, and std::slice_array< _Tp >::_M_sz.

template<typename _Tp> std::valarray< _Tp >::valarray (const gslice_array< _Tp > & __ga) [inline]

Construct an array with the same size and values in ga.

Definition at line 592 of file valarray.

References std::gslice_array< _Tp >::_M_array, and std::gslice_array< _Tp >::_M_index.

template<typename _Tp> std::valarray< _Tp >::valarray (const mask_array< _Tp > & __ma) [inline]

Construct an array with the same size and values in ma.

Definition at line 603 of file valarray.

References std::mask_array< _Tp >::_M_array, and std::mask_array< _Tp >::_M_mask.

template<typename _Tp> std::valarray< _Tp >::valarray (const indirect_array< _Tp > & __ia) [inline]

Construct an array with the same size and values in ia.

Definition at line 612 of file valarray.

References std::indirect_array< _Tp >::_M_array, and std::indirect_array< _Tp >::_M_index.

Member Function Documentation

template<class _Tp> _Expr< _RefFunClos< _ValArray, _Tp >, _Tp > std::valarray< _Tp >::apply (_Tp funcconst _Tp &) const [inline]

Apply a function to the array.

Returns a new valarray with elements assigned to the result of applying func to the corresponding element of this array. The new array has the same size as this one.

Parameters:

func Function of const Tp& returning Tp to apply.

Returns:

New valarray with transformed elements.

Definition at line 906 of file valarray.

template<class _Tp> _Expr< _ValFunClos< _ValArray, _Tp >, _Tp > std::valarray< _Tp >::apply (_Tp func_Tp) const [inline]

Apply a function to the array.

Returns a new valarray with elements assigned to the result of applying func to the corresponding element of this array. The new array has the same size as this one.

Parameters:

func Function of Tp returning Tp to apply.

Returns:

New valarray with transformed elements.

Definition at line 898 of file valarray.

template<class _Tp > valarray< _Tp > std::valarray< _Tp >::cshift (int __n) const [inline]

Return a rotated array.

A new valarray is constructed as a copy of this array with elements in shifted positions. For an element with index i, the new position is (i - n) % size(). The new valarray has the same size as the current one. Elements that are shifted beyond the array bounds are shifted into the other end of the array. No elements are lost.

Positive arguments shift toward index 0, wrapping around the top. Negative arguments shift towards the top, wrapping around to 0.

Parameters:

n Number of element positions to rotate.

Returns:

New valarray with elements in shifted positions.

Definition at line 824 of file valarray.

References std::valarray< _Tp >::_M_data, and std::valarray< _Tp >::_M_size.

template<typename _Tp > _Tp std::valarray< _Tp >::max () const [inline]

Return the maximum element using operator<().

Definition at line 890 of file valarray.

References std::max_element().

template<typename _Tp > _Tp std::valarray< _Tp >::min () const [inline]

Return the minimum element using operator<().

Definition at line 882 of file valarray.

References std::min_element().

template<typename _Tp > valarray< _Tp >::template _UnaryOp< __logical_not >::_Rt std::valarray< _Tp >::operator! () const [inline]

Return a new valarray by applying unary ! to each element.

Definition at line 925 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator%= (const valarray< _Tp > & __v) [inline]

Modulo elements of array by corresponding elements of v.

Definition at line 952 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator%= (const _Tp & __t) [inline]

Set each element e of array to e % t.

Definition at line 952 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator&= (const valarray< _Tp > & __v) [inline]

Logical and corresponding elements of v with elements of array.

Definition at line 954 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator&= (const _Tp & __t) [inline]

Set each element e of array to e & t.

Definition at line 954 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator*= (const valarray< _Tp > & __v) [inline]

Multiply elements of array by corresponding elements of v.

Definition at line 950 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator*= (const _Tp & __t) [inline]

Multiply each element of array by t.

Definition at line 950 of file valarray.

template<typename _Tp > valarray< _Tp >::template _UnaryOp< __unary_plus >::_Rt std::valarray< _Tp >::operator+ () const [inline]

Return a new valarray by applying unary + to each element.

Definition at line 922 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator+= (const valarray< _Tp > & __v) [inline]

Add corresponding elements of v to elements of array.

Definition at line 948 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator+= (const _Tp & __t) [inline]

Add t to each element of array.

Definition at line 948 of file valarray.

template<typename _Tp > valarray< _Tp >::template _UnaryOp< __negate >::_Rt std::valarray< _Tp >::operator- () const [inline]

Return a new valarray by applying unary - to each element.

Definition at line 923 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator-= (const valarray< _Tp > & __v) [inline]

Subtract corresponding elements of v from elements of array.

Definition at line 949 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator-= (const _Tp & __t) [inline]

Subtract t to each element of array.

Definition at line 949 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator/= (const valarray< _Tp > & __v) [inline]

Divide elements of array by corresponding elements of v.

Definition at line 951 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator/= (const _Tp & __t) [inline]

Divide each element of array by t.

Definition at line 951 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator<<= (const valarray< _Tp > & __v) [inline]

Left shift elements of array by corresponding elements of v.

Definition at line 956 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator<<= (const _Tp & __t) [inline]

Left shift each element e of array by t bits.

Definition at line 956 of file valarray.

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const indirect_array< _Tp > & __ia) [inline]

Assign elements to an array subset.

Assign elements of array to values in ia. Results are undefined if ia does not have the same size as this array.

Parameters:

ia Array slice to get values from.

Definition at line 682 of file valarray.

References std::indirect_array< _Tp >::_M_array, std::indirect_array< _Tp >::_M_index, and std::indirect_array< _Tp >::_M_sz.

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const mask_array< _Tp > & __ma) [inline]

Assign elements to an array subset.

Assign elements of array to values in ma. Results are undefined if ma does not have the same size as this array.

Parameters:

ma Array slice to get values from.

Definition at line 672 of file valarray.

References std::mask_array< _Tp >::_M_array, std::mask_array< _Tp >::_M_mask, and std::mask_array< _Tp >::_M_sz.

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const gslice_array< _Tp > & __ga) [inline]

Assign elements to an array subset.

Assign elements of array to values in ga. Results are undefined if ga does not have the same size as this array.

Parameters:

ga Array slice to get values from.

Definition at line 662 of file valarray.

References std::gslice_array< _Tp >::_M_array, std::gslice_array< _Tp >::_M_index, and std::valarray< _Tp >::size().

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const slice_array< _Tp > & __sa) [inline]

Assign elements to an array subset.

Assign elements of array to values in sa. Results are undefined if sa does not have the same size as this array.

Parameters:

sa Array slice to get values from.

Definition at line 652 of file valarray.

References std::slice_array< _Tp >::_M_array, std::slice_array< _Tp >::_M_stride, and std::slice_array< _Tp >::_M_sz.

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const _Tp & __t) [inline]

Assign elements to a value.

Assign all elements of array to t.

Parameters:

t Value for elements.

Definition at line 644 of file valarray.

template<typename _Tp> valarray< _Tp > & std::valarray< _Tp >::operator= (const valarray< _Tp > & __v) [inline]

Assign elements to an array.

Assign elements of array to values in v. Results are undefined if v does not have the same size as this array.

Parameters:

v Valarray to get values from.

Definition at line 635 of file valarray.

References std::valarray< _Tp >::_M_data, and std::valarray< _Tp >::_M_size.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator>>= (const valarray< _Tp > & __v) [inline]

Right shift elements of array by corresponding elements of v.

Definition at line 957 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator>>= (const _Tp & __t) [inline]

Right shift each element e of array by t bits.

Definition at line 957 of file valarray.

template<typename _Tp > indirect_array< _Tp > std::valarray< _Tp >::operator[] (const valarray< size_t > & __i) [inline]

Return a reference to an array subset.

Returns an indirect_array referencing the elements of the array indicated by the argument. The elements in the argument are interpreted as the indices of elements of this valarray to include in the subset. The returned indirect_array refers to these elements.

Parameters:

i The valarray element index list.

Returns:

Indirect_array referencing elements in i.

Definition at line 762 of file valarray.

References std::valarray< _Tp >::size().

template<typename _Tp > _Expr< _IClos< _ValArray, _Tp >, _Tp > std::valarray< _Tp >::operator[] (const valarray< size_t > & __i) const [inline]

Return an array subset.

Returns a new valarray containing the elements of the array indicated by the argument. The elements in the argument are interpreted as the indices of elements of this valarray to copy to the return valarray.

Parameters:

i The valarray element index list.

Returns:

New valarray containing elements in s.

Definition at line 754 of file valarray.

template<typename _Tp > mask_array< _Tp > std::valarray< _Tp >::operator[] (const valarray< bool > & __m) [inline]

Return a reference to an array subset.

Returns a new mask_array referencing the elements of the array indicated by the argument. The input is a valarray of bool which represents a bitmask indicating which elements are part of the subset. Elements of the array are part of the subset if the corresponding element of the argument is true.

Parameters:

m The valarray bitmask.

Returns:

New valarray containing elements indicated by m.

Definition at line 743 of file valarray.

References std::valarray< _Tp >::size().

template<typename _Tp > valarray< _Tp > std::valarray< _Tp >::operator[] (const valarray< bool > & __m) const [inline]

Return an array subset.

Returns a new valarray containing the elements of the array indicated by the argument. The input is a valarray of bool which represents a bitmask indicating which elements should be copied into the new valarray. Each element of the array is added to the return valarray if the corresponding element of the argument is true.

Parameters:

m The valarray bitmask.

Returns:

New valarray containing elements indicated by m.

Definition at line 731 of file valarray.

References std::valarray< _Tp >::size().

template<typename _Tp > gslice_array< _Tp > std::valarray< _Tp >::operator[] (const gslice & __gs) [inline]

Return a reference to an array subset.

Returns a new valarray containing the elements of the array indicated by the gslice argument. The new valarray has the same size as the input gslice.

See also:

gslice.

Parameters:

s The source gslice.

Returns:

New valarray containing elements in s.

Definition at line 723 of file valarray.

References std::gslice::_M_index.

template<typename _Tp > _Expr< _GClos< _ValArray, _Tp >, _Tp > std::valarray< _Tp >::operator[] (const gslice & __gs) const [inline]

Return an array subset.

Returns a slice_array referencing the elements of the array indicated by the slice argument.

See also:

gslice.

Parameters:

s The source slice.

Returns:

Slice_array referencing elements indicated by s.

Definition at line 714 of file valarray.

References std::gslice::_M_index.

template<typename _Tp > slice_array< _Tp > std::valarray< _Tp >::operator[] (slice __s) [inline]

Return a reference to an array subset.

Returns a new valarray containing the elements of the array indicated by the slice argument. The new valarray has the same size as the input slice.

See also:

slice.

Parameters:

s The source slice.

Returns:

New valarray containing elements in s.

Definition at line 709 of file valarray.

template<typename _Tp > _Expr< _SClos< _ValArray, _Tp >, _Tp > std::valarray< _Tp >::operator[] (slice __s) const [inline]

Return an array subset.

Returns a new valarray containing the elements of the array indicated by the slice argument. The new valarray has the same size as the input slice.

See also:

slice.

Parameters:

s The source slice.

Returns:

New valarray containing elements in s.

Definition at line 701 of file valarray.

template<typename _Tp > _Tp & std::valarray< _Tp >::operator[] (size_t __i) [inline]

Return a reference to the i'th array element.

Parameters:

i Index of element to return.

Returns:

Reference to the i'th element.

Definition at line 532 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator^= (const valarray< _Tp > & __v) [inline]

Logical xor corresponding elements of v with elements of array.

Definition at line 953 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator^= (const _Tp & __t) [inline]

Set each element e of array to e ^ t.

Definition at line 953 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator|= (const valarray< _Tp > & __v) [inline]

Logical or corresponding elements of v with elements of array.

Definition at line 955 of file valarray.

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator|= (const _Tp & __t) [inline]

Set each element e of array to e | t.

Definition at line 955 of file valarray.

template<typename _Tp > valarray< _Tp >::template _UnaryOp< __bitwise_not >::_Rt std::valarray< _Tp >::operator~ () const [inline]

Return a new valarray by applying unary ~ to each element.

Definition at line 924 of file valarray.

template<class _Tp> void std::valarray< _Tp >::resize (size_t __size, _Tp __c = _Tp()) [inline]

Resize array.

Resize this array to size and set all elements to c. All references and iterators are invalidated.

Parameters:

size New array size.
c New value for all elements.

Definition at line 865 of file valarray.

template<class _Tp > valarray< _Tp > std::valarray< _Tp >::shift (int __n) const [inline]

Return a shifted array.

A new valarray is constructed as a copy of this array with elements in shifted positions. For an element with index i, the new position is i - n. The new valarray has the same size as the current one. New elements without a value are set to 0. Elements whose new position is outside the bounds of the array are discarded.

Positive arguments shift toward index 0, discarding elements [0, n). Negative arguments discard elements from the top of the array.

Parameters:

n Number of element positions to shift.

Returns:

New valarray with elements in shifted positions.

Definition at line 783 of file valarray.

References std::valarray< _Tp >::_M_data, and std::valarray< _Tp >::_M_size.

template<class _Tp > size_t std::valarray< _Tp >::size () const [inline]

Return the number of elements in array.

Definition at line 770 of file valarray.

Referenced by std::valarray< _Tp >::operator=(), std::gslice_array< _Tp >::operator=(), and std::valarray< _Tp >::operator[]().

template<class _Tp > _Tp std::valarray< _Tp >::sum () const [inline]

Return the sum of all elements in the array.

Accumulates the sum of all elements into a Tp using +=. The order of adding the elements is unspecified.

Definition at line 775 of file valarray.

Author

Generated automatically by Doxygen for libstdc++ from the source code.