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
|
// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------------
//! \addtogroup fn_speye
//! @{
//! Generate a sparse matrix with the values along the main diagonal set to one
template<typename obj_type>
arma_warn_unused
inline
obj_type
speye(const uword n_rows, const uword n_cols, const typename arma_SpMat_SpCol_SpRow_only<obj_type>::result* junk = nullptr)
{
arma_extra_debug_sigprint();
arma_ignore(junk);
if(is_SpCol<obj_type>::value) { arma_debug_check( (n_cols != 1), "speye(): incompatible size" ); }
if(is_SpRow<obj_type>::value) { arma_debug_check( (n_rows != 1), "speye(): incompatible size" ); }
obj_type out;
out.eye(n_rows, n_cols);
return out;
}
template<typename obj_type>
arma_warn_unused
inline
obj_type
speye(const SizeMat& s, const typename arma_SpMat_SpCol_SpRow_only<obj_type>::result* junk = nullptr)
{
arma_extra_debug_sigprint();
arma_ignore(junk);
return speye<obj_type>(s.n_rows, s.n_cols);
}
// Convenience shortcut method (no template parameter necessary)
arma_warn_unused
inline
sp_mat
speye(const uword n_rows, const uword n_cols)
{
arma_extra_debug_sigprint();
sp_mat out;
out.eye(n_rows, n_cols);
return out;
}
arma_warn_unused
inline
sp_mat
speye(const SizeMat& s)
{
arma_extra_debug_sigprint();
sp_mat out;
out.eye(s.n_rows, s.n_cols);
return out;
}
//! @}
|
