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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Copyright © 2023 Marvin Beckmann
//
// This file is part of qFALL-math.
//
// qFALL-math is free software: you can redistribute it and/or modify it under
// the terms of the Mozilla Public License Version 2.0 as published by the
// Mozilla Foundation. See <https://mozilla.org/en-US/MPL/2.0/>.
//! Implementations to concatenate two [`MatPolyOverZ`].
use super::MatPolyOverZ;
use crate::{
error::MathError,
traits::{Concatenate, MatrixDimensions},
};
use flint_sys::fmpz_poly_mat::{fmpz_poly_mat_concat_horizontal, fmpz_poly_mat_concat_vertical};
impl Concatenate for &MatPolyOverZ {
type Output = MatPolyOverZ;
/// Concatenates `self` with `other` vertically, i.e. `other` is added below.
///
/// Parameters:
/// - `other`: the other matrix to concatenate with `self`
///
/// Returns a vertical concatenation of the two matrices or
/// an error, if the matrices can not be concatenated vertically.
///
/// # Examples
/// ```
/// use qfall_math::traits::*;
/// use qfall_math::integer::MatPolyOverZ;
///
/// let mat_1 = MatPolyOverZ::new(13, 5);
/// let mat_2 = MatPolyOverZ::new(17, 5);
///
/// let mat_vert = mat_1.concat_vertical(&mat_2).unwrap();
/// ```
///
/// # Errors and Failures
/// - Returns a [`MathError`] of type
/// [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
/// if the matrices can not be concatenated due to mismatching dimensions.
fn concat_vertical(self, other: Self) -> Result<Self::Output, crate::error::MathError> {
if self.get_num_columns() != other.get_num_columns() {
return Err(MathError::MismatchingMatrixDimension(format!(
"Tried to concatenate vertically a '{}x{}' matrix and a '{}x{}' matrix.",
self.get_num_rows(),
self.get_num_columns(),
other.get_num_rows(),
other.get_num_columns()
)));
}
let mut out = MatPolyOverZ::new(
self.get_num_rows() + other.get_num_rows(),
self.get_num_columns(),
);
unsafe {
fmpz_poly_mat_concat_vertical(&mut out.matrix, &self.matrix, &other.matrix);
}
Ok(out)
}
/// Concatenates `self` with `other` horizontally, i.e. `other` is added on the right.
///
/// Parameters:
/// - `other`: the other matrix to concatenate with `self`
///
/// Returns a horizontal concatenation of the two matrices or a
/// an error, if the matrices can not be concatenated horizontally.
///
/// # Examples
/// ```
/// use qfall_math::traits::*;
/// use qfall_math::integer::MatPolyOverZ;
///
/// let mat_1 = MatPolyOverZ::new(17, 5);
/// let mat_2 = MatPolyOverZ::new(17, 6);
///
/// let mat_vert = mat_1.concat_horizontal(&mat_2).unwrap();
/// ```
///
/// # Errors and Failures
/// - Returns a [`MathError`] of type
/// [`MismatchingMatrixDimension`](MathError::MismatchingMatrixDimension)
/// if the matrices can not be concatenated due to mismatching dimensions.
fn concat_horizontal(self, other: Self) -> Result<Self::Output, crate::error::MathError> {
if self.get_num_rows() != other.get_num_rows() {
return Err(MathError::MismatchingMatrixDimension(format!(
"Tried to concatenate horizontally a '{}x{}' matrix and a '{}x{}' matrix.",
self.get_num_rows(),
self.get_num_columns(),
other.get_num_rows(),
other.get_num_columns()
)));
}
let mut out = MatPolyOverZ::new(
self.get_num_rows(),
self.get_num_columns() + other.get_num_columns(),
);
unsafe {
fmpz_poly_mat_concat_horizontal(&mut out.matrix, &self.matrix, &other.matrix);
}
Ok(out)
}
}
#[cfg(test)]
mod test_concatenate {
use crate::{
integer::MatPolyOverZ,
traits::{Concatenate, MatrixDimensions},
};
use std::str::FromStr;
/// Ensure that the dimensions are taken over correctly and an error occurs
/// if the dimensions mismatch
#[test]
fn dimensions_vertical() {
let mat_1 = MatPolyOverZ::new(13, 5);
let mat_2 = MatPolyOverZ::new(17, 5);
let mat_3 = MatPolyOverZ::new(17, 6);
let mat_vert = mat_1.concat_vertical(&mat_2).unwrap();
assert_eq!(5, mat_vert.get_num_columns());
assert_eq!(30, mat_vert.get_num_rows());
assert!(mat_1.concat_vertical(&mat_3).is_err());
}
/// Ensure that the dimensions are taken over correctly and an error occurs
/// if the dimensions mismatch
#[test]
fn dimensions_horizontal() {
let mat_1 = MatPolyOverZ::new(13, 5);
let mat_2 = MatPolyOverZ::new(17, 5);
let mat_3 = MatPolyOverZ::new(17, 6);
let mat_hor = mat_2.concat_horizontal(&mat_3).unwrap();
assert_eq!(11, mat_hor.get_num_columns());
assert_eq!(17, mat_hor.get_num_rows());
assert!(mat_1.concat_horizontal(&mat_2).is_err());
}
/// Ensure that vertical concatenation works correctly
#[test]
fn vertically_correct() {
let mat_1 = MatPolyOverZ::from_str(&format!(
"[[1 1, 1 2, 1 {}],[0, 1 5, 1 {}]]",
i64::MIN,
u64::MAX
))
.unwrap();
let mat_2 = MatPolyOverZ::from_str("[[1 -1, 1 2, 1 -17]]").unwrap();
let mat_vertical = mat_1.concat_vertical(&mat_2).unwrap();
let cmp_mat = MatPolyOverZ::from_str(&format!(
"[[1 1, 1 2, 1 {}],[0, 1 5, 1 {}],[1 -1, 1 2, 1 -17]]",
i64::MIN,
u64::MAX
))
.unwrap();
assert_eq!(cmp_mat, mat_vertical);
}
/// Ensure that horizontal concatenation works correctly
#[test]
fn horizontally_correct() {
let mat_1 = MatPolyOverZ::from_str(&format!(
"[[1 1, 1 2, 1 {}],[0, 1 5, 1 {}]]",
i64::MIN,
u64::MAX
))
.unwrap();
let mat_2 = MatPolyOverZ::from_str("[[1 -1, 1 2],[0, 1 5]]").unwrap();
let mat_horizontal = mat_1.concat_horizontal(&mat_2).unwrap();
let cmp_mat = MatPolyOverZ::from_str(&format!(
"[[1 1, 1 2, 1 {}, 1 -1, 1 2],[0, 1 5, 1 {}, 0, 1 5]]",
i64::MIN,
u64::MAX
))
.unwrap();
assert_eq!(cmp_mat, mat_horizontal);
}
}