1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// Copyright © 2026 Mikhail Hogrefe
//
// This file is part of Malachite.
//
// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.
use crate::integer_vector::IntegerVector;
use crate::integer_vector::arithmetic::dot_general::vec_dot_general;
use crate::natural::Natural;
use malachite_base::num::arithmetic::traits::AbsSquared;
impl AbsSquared for IntegerVector {
type Output = Natural;
/// Computes the squared norm of an [`IntegerVector`], the sum of the squares of its elements,
/// taking the vector by value.
///
/// This is the dot product of the vector with itself, $\|v\|^2$. The squared norm of the
/// 0-dimensional vector is 0. The squared norm is non-negative, so it is returned as a
/// [`Natural`].
///
/// $$
/// f(v) = \|v\|^2 = \sum_{i=0}^{n-1} v_i^2,
/// $$
///
/// where $n$ is the dimension of $v$.
///
/// # Worst-case complexity
/// $T(n, m) = O(nm \log m \log\log m)$
///
/// $M(m) = O(m \log m)$
///
/// where $T$ is time, $M$ is additional memory, $n$ is the dimension of the vector, and $m$ is
/// the largest number of significant bits of any element.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::AbsSquared;
/// use malachite_nz::integer_vector::IntegerVector;
///
/// let v = IntegerVector::from_str("(3, -4, 12)").unwrap();
/// assert_eq!(v.abs_squared(), 169);
/// let v = IntegerVector::from_str("()").unwrap();
/// assert_eq!(v.abs_squared(), 0);
/// ```
///
/// This is equivalent to `_fmpz_vec_dot` from `fmpz_vec/dot.c`, FLINT 3.6.0, with both vectors
/// the same, which squares each element instead of multiplying it by itself.
#[inline]
fn abs_squared(self) -> Natural {
vec_dot_general(None, false, &self.elements, &self.elements, false).abs
}
}
impl AbsSquared for &IntegerVector {
type Output = Natural;
/// Computes the squared norm of an [`IntegerVector`], the sum of the squares of its elements,
/// taking the vector by reference.
///
/// This is the dot product of the vector with itself, $\|v\|^2$. The squared norm of the
/// 0-dimensional vector is 0. The squared norm is non-negative, so it is returned as a
/// [`Natural`].
///
/// $$
/// f(v) = \|v\|^2 = \sum_{i=0}^{n-1} v_i^2,
/// $$
///
/// where $n$ is the dimension of $v$.
///
/// # Worst-case complexity
/// $T(n, m) = O(nm \log m \log\log m)$
///
/// $M(m) = O(m \log m)$
///
/// where $T$ is time, $M$ is additional memory, $n$ is the dimension of the vector, and $m$ is
/// the largest number of significant bits of any element.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::AbsSquared;
/// use malachite_nz::integer_vector::IntegerVector;
///
/// let v = IntegerVector::from_str("(3, -4, 12)").unwrap();
/// assert_eq!((&v).abs_squared(), 169);
/// let v = IntegerVector::from_str("()").unwrap();
/// assert_eq!((&v).abs_squared(), 0);
/// ```
///
/// This is equivalent to `_fmpz_vec_dot` from `fmpz_vec/dot.c`, FLINT 3.6.0, with both vectors
/// the same, which squares each element instead of multiplying it by itself.
#[inline]
fn abs_squared(self) -> Natural {
vec_dot_general(None, false, &self.elements, &self.elements, false).abs
}
}