fn_solve.hpp 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. // Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
  2. // Copyright 2008-2016 National ICT Australia (NICTA)
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. // ------------------------------------------------------------------------
  15. //! \addtogroup fn_solve
  16. //! @{
  17. //
  18. // solve_gen
  19. template<typename T1, typename T2>
  20. arma_warn_unused
  21. inline
  22. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_gen> >::result
  23. solve
  24. (
  25. const Base<typename T1::elem_type,T1>& A,
  26. const Base<typename T1::elem_type,T2>& B,
  27. const solve_opts::opts& opts = solve_opts::none
  28. )
  29. {
  30. arma_extra_debug_sigprint();
  31. return Glue<T1, T2, glue_solve_gen>(A.get_ref(), B.get_ref(), opts.flags);
  32. }
  33. //! NOTE: don't use this form: it will be removed
  34. template<typename T1, typename T2>
  35. arma_deprecated
  36. inline
  37. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_gen> >::result
  38. solve
  39. (
  40. const Base<typename T1::elem_type,T1>& A,
  41. const Base<typename T1::elem_type,T2>& B,
  42. const bool // argument kept only for compatibility with old user code
  43. )
  44. {
  45. arma_extra_debug_sigprint();
  46. // arma_debug_warn("solve(A,B,bool) is deprecated and will be removed; change to solve(A,B)");
  47. return Glue<T1, T2, glue_solve_gen>(A.get_ref(), B.get_ref(), solve_opts::flag_none);
  48. }
  49. //! NOTE: don't use this form: it will be removed
  50. template<typename T1, typename T2>
  51. arma_deprecated
  52. inline
  53. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_gen> >::result
  54. solve
  55. (
  56. const Base<typename T1::elem_type,T1>& A,
  57. const Base<typename T1::elem_type,T2>& B,
  58. const char* // argument kept only for compatibility with old user code
  59. )
  60. {
  61. arma_extra_debug_sigprint();
  62. // arma_debug_warn("solve(A,B,char*) is deprecated and will be removed; change to solve(A,B)");
  63. return Glue<T1, T2, glue_solve_gen>(A.get_ref(), B.get_ref(), solve_opts::flag_none);
  64. }
  65. template<typename T1, typename T2>
  66. inline
  67. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  68. solve
  69. (
  70. Mat<typename T1::elem_type>& out,
  71. const Base<typename T1::elem_type,T1>& A,
  72. const Base<typename T1::elem_type,T2>& B,
  73. const solve_opts::opts& opts = solve_opts::none
  74. )
  75. {
  76. arma_extra_debug_sigprint();
  77. return glue_solve_gen::apply(out, A.get_ref(), B.get_ref(), opts.flags);
  78. }
  79. //! NOTE: don't use this form: it will be removed
  80. template<typename T1, typename T2>
  81. arma_deprecated
  82. inline
  83. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  84. solve
  85. (
  86. Mat<typename T1::elem_type>& out,
  87. const Base<typename T1::elem_type,T1>& A,
  88. const Base<typename T1::elem_type,T2>& B,
  89. const bool // argument kept only for compatibility with old user code
  90. )
  91. {
  92. arma_extra_debug_sigprint();
  93. // arma_debug_warn("solve(X,A,B,bool) is deprecated and will be removed; change to solve(X,A,B)");
  94. return glue_solve_gen::apply(out, A.get_ref(), B.get_ref(), solve_opts::flag_none);
  95. }
  96. //! NOTE: don't use this form: it will be removed
  97. template<typename T1, typename T2>
  98. arma_deprecated
  99. inline
  100. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  101. solve
  102. (
  103. Mat<typename T1::elem_type>& out,
  104. const Base<typename T1::elem_type,T1>& A,
  105. const Base<typename T1::elem_type,T2>& B,
  106. const char* // argument kept only for compatibility with old user code
  107. )
  108. {
  109. arma_extra_debug_sigprint();
  110. // arma_debug_warn("solve(X,A,B,char*) is deprecated and will be removed; change to solve(X,A,B)");
  111. return glue_solve_gen::apply(out, A.get_ref(), B.get_ref(), solve_opts::flag_none);
  112. }
  113. //
  114. // solve_tri
  115. template<typename T1, typename T2>
  116. arma_warn_unused
  117. inline
  118. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_tri_default> >::result
  119. solve
  120. (
  121. const Op<T1, op_trimat>& A,
  122. const Base<typename T1::elem_type,T2>& B
  123. )
  124. {
  125. arma_extra_debug_sigprint();
  126. uword flags = uword(0);
  127. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  128. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  129. return Glue<T1, T2, glue_solve_tri_default>(A.m, B.get_ref(), flags);
  130. }
  131. template<typename T1, typename T2>
  132. arma_warn_unused
  133. inline
  134. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_tri> >::result
  135. solve
  136. (
  137. const Op<T1, op_trimat>& A,
  138. const Base<typename T1::elem_type,T2>& B,
  139. const solve_opts::opts& opts
  140. )
  141. {
  142. arma_extra_debug_sigprint();
  143. uword flags = opts.flags;
  144. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  145. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  146. return Glue<T1, T2, glue_solve_tri>(A.m, B.get_ref(), flags);
  147. }
  148. //! NOTE: don't use this form: it will be removed
  149. template<typename T1, typename T2>
  150. arma_deprecated
  151. inline
  152. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_tri_default> >::result
  153. solve
  154. (
  155. const Op<T1, op_trimat>& A,
  156. const Base<typename T1::elem_type,T2>& B,
  157. const bool // argument kept only for compatibility with old user code
  158. )
  159. {
  160. arma_extra_debug_sigprint();
  161. // arma_debug_warn("solve(A,B,bool) is deprecated and will be removed; change to solve(A,B)");
  162. uword flags = uword(0);
  163. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  164. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  165. return Glue<T1, T2, glue_solve_tri_default>(A.m, B.get_ref(), flags);
  166. }
  167. //! NOTE: don't use this form: it will be removed
  168. template<typename T1, typename T2>
  169. arma_deprecated
  170. inline
  171. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Glue<T1, T2, glue_solve_tri_default> >::result
  172. solve
  173. (
  174. const Op<T1, op_trimat>& A,
  175. const Base<typename T1::elem_type,T2>& B,
  176. const char* // argument kept only for compatibility with old user code
  177. )
  178. {
  179. arma_extra_debug_sigprint();
  180. // arma_debug_warn("solve(A,B,char*) is deprecated and will be removed; change to solve(A,B)");
  181. uword flags = uword(0);
  182. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  183. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  184. return Glue<T1, T2, glue_solve_tri_default>(A.m, B.get_ref(), flags);
  185. }
  186. template<typename T1, typename T2>
  187. inline
  188. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  189. solve
  190. (
  191. Mat<typename T1::elem_type>& out,
  192. const Op<T1, op_trimat>& A,
  193. const Base<typename T1::elem_type,T2>& B
  194. )
  195. {
  196. arma_extra_debug_sigprint();
  197. uword flags = uword(0);
  198. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  199. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  200. return glue_solve_tri_default::apply(out, A.m, B.get_ref(), flags);
  201. }
  202. template<typename T1, typename T2>
  203. inline
  204. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  205. solve
  206. (
  207. Mat<typename T1::elem_type>& out,
  208. const Op<T1, op_trimat>& A,
  209. const Base<typename T1::elem_type,T2>& B,
  210. const solve_opts::opts& opts
  211. )
  212. {
  213. arma_extra_debug_sigprint();
  214. uword flags = opts.flags;
  215. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  216. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  217. return glue_solve_tri::apply(out, A.m, B.get_ref(), flags);
  218. }
  219. //! NOTE: don't use this form: it will be removed
  220. template<typename T1, typename T2>
  221. arma_deprecated
  222. inline
  223. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  224. solve
  225. (
  226. Mat<typename T1::elem_type>& out,
  227. const Op<T1, op_trimat>& A,
  228. const Base<typename T1::elem_type,T2>& B,
  229. const bool // argument kept only for compatibility with old user code
  230. )
  231. {
  232. arma_extra_debug_sigprint();
  233. // arma_debug_warn("solve(X,A,B,bool) is deprecated and will be removed; change to solve(X,A,B)");
  234. uword flags = uword(0);
  235. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  236. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  237. return glue_solve_tri_default::apply(out, A.m, B.get_ref(), flags);
  238. }
  239. //! NOTE: don't use this form: it will be removed
  240. template<typename T1, typename T2>
  241. arma_deprecated
  242. inline
  243. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  244. solve
  245. (
  246. Mat<typename T1::elem_type>& out,
  247. const Op<T1, op_trimat>& A,
  248. const Base<typename T1::elem_type,T2>& B,
  249. const char* // argument kept only for compatibility with old user code
  250. )
  251. {
  252. arma_extra_debug_sigprint();
  253. // arma_debug_warn("solve(X,A,B,char*) is deprecated and will be removed; change to solve(X,A,B)");
  254. uword flags = uword(0);
  255. if(A.aux_uword_a == 0) { flags |= solve_opts::flag_triu; }
  256. if(A.aux_uword_a == 1) { flags |= solve_opts::flag_tril; }
  257. return glue_solve_tri_default::apply(out, A.m, B.get_ref(), flags);
  258. }
  259. //! @}