Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/numeric/valarray/abs"

From cppreference.com
< cpp‎ | numeric‎ | valarray
m (better links to the other abs()'s)
m (fmt, {{c}}, headers sorted)
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{cpp/title|abs{{small|(std::valarray)}}}}
 
{{cpp/title|abs{{small|(std::valarray)}}}}
{{cpp/numeric/valarray/sidebar}}
+
{{cpp/numeric/valarray/navbar}}
{{ddcl | header=valarray | 1=
+
{{ddcl|header=valarray|1=
 
template< class T >
 
template< class T >
 
valarray<T> abs( const valarray<T>& va );
 
valarray<T> abs( const valarray<T>& va );
 
}}
 
}}
  
Computes absolute value of each element in the value array. This is done by applying {{cpp|abs}} (unqualified) function.  
+
Computes absolute value of each element in the value array.
  
 
===Parameters===
 
===Parameters===
{{param list begin}}
+
{{par begin}}
{{param list item | va | value array to apply the operation to}}
+
{{par|va|value array to apply the operation to}}
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
Value array containing absolute values of the values in {{tt|va}}.
+
Value array containing absolute values of the values in {{c|va}}.
  
 
===Notes===
 
===Notes===
{{cpp/numeric/valarray/notes|abs}}
+
{{cpp/numeric/valarray/notes unq|abs}}
  
===Equivalent function===
+
{{cpp/numeric/valarray/notes ret|abs}}
{{eq fun cpp | 1=
+
 
template< class T >
+
===Possible implementation===
valarray<T> abs( const valarray<T>& va )
+
{{cpp/numeric/valarray/impl|abs}}
{
+
    valarray<T> other = va;
+
    for (T &i : other) {
+
        i = abs(i);
+
    }
+
    return other; // proxy object may be returned
+
}
+
}}
+
  
 
===Example===
 
===Example===
{{example cpp
+
{{example
 
|code=
 
|code=
 +
#include <iostream>
 
#include <valarray>
 
#include <valarray>
#include <iostream>
+
 
 
int main()
 
int main()
 
{
 
{
 
     std::valarray<int> v{1, -2, 3, -4, 5, -6, 7, -8};
 
     std::valarray<int> v{1, -2, 3, -4, 5, -6, 7, -8};
 
     std::valarray<int> v2 = std::abs(v);
 
     std::valarray<int> v2 = std::abs(v);
     for(auto n : v2)
+
     for (auto n : v2)
 
         std::cout << n << ' ';
 
         std::cout << n << ' ';
 
     std::cout << '\n';
 
     std::cout << '\n';
Line 50: Line 43:
  
 
===See also===
 
===See also===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list fun | cpp/numeric/math/abs | title=abs{{dcl small|(int)}} | computes absolute value of an integral value ({{math|{{!}}x{{!}}}})}}
+
{{dsc inc|cpp/numeric/math/dsc abs}}
{{dcl list fun | cpp/numeric/math/fabs | title=abs{{dcl small|(float)}} | absolute value of a floating point value ({{math|{{!}}x{{!}}}}) }}
+
{{dsc inc|cpp/numeric/math/dsc fabs}}
{{dcl list template | cpp/numeric/complex/dcl list abs}}
+
{{dsc inc|cpp/numeric/complex/dsc abs}}
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 23:43, 16 October 2023

 
 
 
 
Defined in header <valarray>
template< class T >
valarray<T> abs( const valarray<T>& va );

Computes absolute value of each element in the value array.

Contents

[edit] Parameters

va - value array to apply the operation to

[edit] Return value

Value array containing absolute values of the values in va.

[edit] Notes

Unqualified function (abs) is used to perform the computation. If such function is not available, std::abs is used due to argument-dependent lookup.

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

[edit] Possible implementation

template<class T>
valarray<T> abs(const valarray<T>& va)
{
    valarray<T> other = va;
    for (T& i : other)
        i = abs(i);
 
    return other; // proxy object may be returned
}

[edit] Example

#include <iostream>
#include <valarray>
 
int main()
{
    std::valarray<int> v{1, -2, 3, -4, 5, -6, 7, -8};
    std::valarray<int> v2 = std::abs(v);
    for (auto n : v2)
        std::cout << n << ' ';
    std::cout << '\n';
}

Output:

1 2 3 4 5 6 7 8

[edit] See also

computes absolute value of an integral value (|x|)
(function) [edit]
absolute value of a floating point value (|x|)
(function) [edit]
returns the magnitude of a complex number
(function template) [edit]