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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
// 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::arithmetic::max_bits::vec_max_bits;
use crate::natural::Natural;
use crate::natural_vector::{NaturalVector, ZERO};
use malachite_base::num::arithmetic::traits::{Height, HeightRef};
use malachite_base::num::basic::traits::Zero;
impl Height for NaturalVector {
type Output = Natural;
/// Returns the height of a [`NaturalVector`]: the largest of its elements, taking the vector by
/// reference and cloning.
///
/// The 0-dimensional vector has no elements, and its height is 0.
///
/// $$
/// f(v) = H(v) = \max_i v_i.
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(m)$
///
/// where $T$ is time, $M$ is additional memory, $n$ is the total number of bits of the
/// elements, and $m$ is the number of bits of the height.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::Height;
/// use malachite_nz::natural_vector::NaturalVector;
///
/// assert_eq!(NaturalVector::from_str("(1, 3, 2)").unwrap().to_height(), 3);
/// assert_eq!(NaturalVector::from_str("()").unwrap().to_height(), 0);
/// ```
///
/// This is equivalent to `_fmpz_vec_height` from `fmpz_vec/height.c`, FLINT 3.6.0.
#[inline]
fn to_height(&self) -> Natural {
self.height_ref().clone()
}
/// Returns the height of a [`NaturalVector`]: the largest of its elements, taking the vector by
/// value.
///
/// The element of largest height, or the part of it that is the height, is moved out of the
/// vector rather than cloned.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is the total number of bits of the
/// elements.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::Height;
/// use malachite_nz::natural_vector::NaturalVector;
///
/// assert_eq!(
/// NaturalVector::from_str("(1, 3, 2)").unwrap().into_height(),
/// 3
/// );
/// assert_eq!(NaturalVector::from_str("()").unwrap().into_height(), 0);
/// ```
#[inline]
fn into_height(self) -> Natural {
self.elements.into_iter().max().unwrap_or(Natural::ZERO)
}
/// Returns the number of significant bits of the height of a [`NaturalVector`].
///
/// Since bit length is monotone, this is the largest of the elements' heights' bit lengths, and
/// 0 for the 0-dimensional vector, without materializing the height.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is the total number of bits of the
/// elements.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::Height;
/// use malachite_nz::natural_vector::NaturalVector;
///
/// assert_eq!(
/// NaturalVector::from_str("(1, 3, 2)")
/// .unwrap()
/// .height_significant_bits(),
/// 2
/// );
/// assert_eq!(
/// NaturalVector::from_str("()")
/// .unwrap()
/// .height_significant_bits(),
/// 0
/// );
/// ```
#[inline]
fn height_significant_bits(&self) -> u64 {
vec_max_bits(&self.elements).0
}
}
impl HeightRef for NaturalVector {
/// Returns a reference to the height of a [`NaturalVector`]: the largest of its elements.
///
/// The height is one of the magnitudes the vector already holds, so it is lent rather than
/// built. For the 0-dimensional vector, a reference to 0 is returned.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is the total number of bits of the
/// elements.
///
/// # Examples
/// ```
/// use core::str::FromStr;
/// use malachite_base::num::arithmetic::traits::HeightRef;
/// use malachite_nz::natural_vector::NaturalVector;
///
/// assert_eq!(
/// *NaturalVector::from_str("(1, 3, 2)").unwrap().height_ref(),
/// 3
/// );
/// assert_eq!(*NaturalVector::from_str("()").unwrap().height_ref(), 0);
/// ```
#[inline]
fn height_ref(&self) -> &Natural {
self.elements.iter().max().unwrap_or(&ZERO)
}
}