sparsity_internal.hpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  * Copyright (C) 2005-2013 Timothy A. Davis
9  *
10  * CasADi is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 3 of the License, or (at your option) any later version.
14  *
15  * CasADi is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with CasADi; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 
27 #ifndef CASADI_SPARSITY_INTERNAL_HPP
28 #define CASADI_SPARSITY_INTERNAL_HPP
29 
30 #include "sparsity.hpp"
31 #include "shared_object_internal.hpp"
33 
34 namespace casadi {
35 
36  class CASADI_EXPORT SparsityInternal : public SharedObjectInternal {
37  private:
47  std::vector<casadi_int> sp_;
48 
52  struct Btf {
53  casadi_int nb;
54  std::vector<casadi_int> rowperm, colperm;
55  std::vector<casadi_int> rowblock, colblock;
56  std::vector<casadi_int> coarse_rowblock, coarse_colblock;
57  };
58 
64  mutable Btf* btf_;
65 
66  public:
68  SparsityInternal(casadi_int nrow, casadi_int ncol,
69  const casadi_int* colind, const casadi_int* row);
70 
72  ~SparsityInternal() override;
73 
77  inline const std::vector<casadi_int>& sp() const { return sp_;}
78 
82  inline casadi_int size1() const { return sp_[0];}
83 
87  inline casadi_int size2() const { return sp_[1];}
88 
92  inline const casadi_int* colind() const { return &sp_.front()+2;}
93 
97  inline const casadi_int* row() const { return colind()+size2()+1;}
98 
100  inline casadi_int nnz() const { return colind()[size2()];}
101 
107  Sparsity get_diag(std::vector<casadi_int>& mapping) const;
108 
110  bool has_diag() const;
111 
113  Sparsity drop_diag() const;
114 
122  casadi_int dfs(casadi_int j, casadi_int top, std::vector<casadi_int>& xi,
123  std::vector<casadi_int>& pstack,
124  const std::vector<casadi_int>& pinv, std::vector<bool>& marked) const;
125 
133  casadi_int scc(std::vector<casadi_int>& p, std::vector<casadi_int>& r) const;
134 
142  std::vector<casadi_int> amd() const;
143 
154  static void etree(const casadi_int* sp, casadi_int* parent, casadi_int *w, casadi_int ata);
155 
164  static casadi_int postorder_dfs(casadi_int j, casadi_int k, casadi_int* head,
165  const casadi_int* next, casadi_int* post, casadi_int* stack);
166 
177  static void postorder(const casadi_int* parent, casadi_int n, casadi_int* post, casadi_int* w);
178 
187  static casadi_int leaf(casadi_int i, casadi_int j, const casadi_int* first,
188  casadi_int* maxfirst,
189  casadi_int* prevleaf, casadi_int* ancestor, casadi_int* jleaf);
190 
201  static casadi_int qr_counts(const casadi_int* tr_sp, const casadi_int* parent,
202  const casadi_int* post, casadi_int* counts, casadi_int* w);
203 
215  static casadi_int qr_nnz(const casadi_int* sp, casadi_int* pinv, casadi_int* leftmost,
216  const casadi_int* parent, casadi_int* nrow_ext, casadi_int* w);
217 
226  static void qr_init(const casadi_int* sp, const casadi_int* sp_tr,
227  casadi_int* leftmost, casadi_int* parent, casadi_int* pinv,
228  casadi_int* nrow_ext, casadi_int* v_nnz, casadi_int* r_nnz, casadi_int* w);
229 
246  static void qr_sparsities(
247  const casadi_int* sp_a, casadi_int nrow_ext, casadi_int* sp_v, casadi_int* sp_r,
248  const casadi_int* leftmost, const casadi_int* parent, const casadi_int* pinv,
249  casadi_int* iw);
250 
263  static void ldl_colind(const casadi_int* sp, casadi_int* parent,
264  casadi_int* l_colind, casadi_int* w);
265 
276  static void ldl_row(const casadi_int* sp, const casadi_int* parent,
277  casadi_int* l_colind, casadi_int* l_row, casadi_int *w);
278 
280  Sparsity T() const;
281 
287  Sparsity transpose(std::vector<casadi_int>& mapping, bool invert_mapping=false) const;
288 
290  bool is_transpose(const SparsityInternal& y) const;
291 
293  bool is_reshape(const SparsityInternal& y) const;
294 
302  void bfs(casadi_int n, std::vector<casadi_int>& wi, std::vector<casadi_int>& wj,
303  std::vector<casadi_int>& queue, const std::vector<casadi_int>& imatch,
304  const std::vector<casadi_int>& jmatch, casadi_int mark) const;
305 
313  static void matched(
314  casadi_int n, const std::vector<casadi_int>& wj, const std::vector<casadi_int>& imatch,
315  std::vector<casadi_int>& p, std::vector<casadi_int>& q, std::vector<casadi_int>& cc,
316  std::vector<casadi_int>& rr, casadi_int set, casadi_int mark);
317 
325  static void unmatched(casadi_int m, const std::vector<casadi_int>& wi,
326  std::vector<casadi_int>& p, std::vector<casadi_int>& rr, casadi_int set);
327 
335  static casadi_int rprune(casadi_int i, casadi_int j, double aij, void *other);
336 
344  static casadi_int drop(casadi_int (*fkeep)(casadi_int, casadi_int, double, void *), void *other,
345  casadi_int nrow, casadi_int ncol,
346  std::vector<casadi_int>& colind, std::vector<casadi_int>& row);
347 
349  casadi_int btf(std::vector<casadi_int>& rowperm, std::vector<casadi_int>& colperm,
350  std::vector<casadi_int>& rowblock, std::vector<casadi_int>& colblock,
351  std::vector<casadi_int>& coarse_rowblock,
352  std::vector<casadi_int>& coarse_colblock) const {
353  T()->dmperm(colperm, rowperm, colblock, rowblock,
354  coarse_colblock, coarse_rowblock);
355  return rowblock.size()-1;
356  }
357 
359  const Btf& btf() const;
360 
368  void dmperm(std::vector<casadi_int>& rowperm, std::vector<casadi_int>& colperm,
369  std::vector<casadi_int>& rowblock, std::vector<casadi_int>& colblock,
370  std::vector<casadi_int>& coarse_rowblock,
371  std::vector<casadi_int>& coarse_colblock) const;
372 
380  void maxtrans(std::vector<casadi_int>& imatch,
381  std::vector<casadi_int>& jmatch, Sparsity& trans, casadi_int seed) const;
382 
390  void augment(casadi_int k, std::vector<casadi_int>& jmatch,
391  casadi_int *cheap, std::vector<casadi_int>& w, casadi_int *js,
392  casadi_int *is, casadi_int *ps) const;
393 
403  static std::vector<casadi_int> randperm(casadi_int n, casadi_int seed);
404 
408  static std::vector<casadi_int> invertPermutation(const std::vector<casadi_int>& p);
409 
411  Sparsity permute(const std::vector<casadi_int>& pinv,
412  const std::vector<casadi_int>& q, casadi_int values) const;
413 
421  void permute(const std::vector<casadi_int>& pinv,
422  const std::vector<casadi_int>& q, casadi_int values,
423  std::vector<casadi_int>& colind_C,
424  std::vector<casadi_int>& row_C) const;
425 
433  static casadi_int wclear(casadi_int mark, casadi_int lemax, casadi_int *w, casadi_int n);
434 
442  static casadi_int diag(casadi_int i, casadi_int j, double aij, void *other);
443 
451  Sparsity multiply(const Sparsity& B) const;
452 
460  casadi_int scatter(casadi_int j, std::vector<casadi_int>& w, casadi_int mark,
461  casadi_int* Ci, casadi_int nz) const;
462 
464  std::vector<casadi_int> get_row() const;
465 
467  std::vector<casadi_int> get_colind() const;
468 
470  std::vector<casadi_int> get_col() const;
471 
473  Sparsity _resize(casadi_int nrow, casadi_int ncol) const;
474 
476  Sparsity _reshape(casadi_int nrow, casadi_int ncol) const;
477 
479  casadi_int numel() const;
480 
482  casadi_int nnz_lower(bool strictly=false) const;
483 
485  casadi_int nnz_upper(bool strictly=false) const;
486 
488  casadi_int nnz_diag() const;
489 
493  casadi_int bw_upper() const;
494 
498  casadi_int bw_lower() const;
499 
501  std::pair<casadi_int, casadi_int> size() const;
502 
504  bool is_scalar(bool scalar_and_dense) const;
505 
512  bool is_empty(bool both=false) const;
513 
515  bool is_dense() const;
516 
520  bool is_row() const;
521 
525  bool is_column() const;
526 
530  bool is_vector() const;
531 
533  bool is_diag() const;
534 
536  bool is_square() const;
537 
541  bool is_permutation() const;
542 
546  bool is_selection(bool allow_empty=false) const;
547 
551  bool is_orthonormal(bool allow_empty=false) const;
552 
556  bool is_orthonormal_rows(bool allow_empty=false) const;
557 
561  bool is_orthonormal_columns(bool allow_empty=false) const;
562 
564  bool is_symmetric() const;
565 
567  bool is_tril(bool strictly) const;
568 
570  bool is_triu(bool strictly) const;
571 
573  Sparsity _triu(bool includeDiagonal) const;
574 
576  Sparsity _tril(bool includeDiagonal) const;
577 
579  std::vector<casadi_int> get_lower() const;
580 
582  std::vector<casadi_int> get_upper() const;
583 
585  std::string dim(bool with_nz=false) const;
586 
588  std::string repr_el(casadi_int k) const;
589 
591  Sparsity _mtimes(const Sparsity& y) const;
592 
595  Sparsity combine(const Sparsity& y, bool f0x_is_zero, bool function0_is_zero,
596  std::vector<unsigned char>& mapping) const;
597  Sparsity combine(const Sparsity& y, bool f0x_is_zero, bool function0_is_zero) const;
598 
599  template<bool with_mapping>
600  Sparsity combineGen1(const Sparsity& y, bool f0x_is_zero, bool function0_is_zero,
601  std::vector<unsigned char>& mapping) const;
602 
603  template<bool with_mapping, bool f0x_is_zero, bool function0_is_zero>
604  Sparsity combineGen(const Sparsity& y, std::vector<unsigned char>& mapping) const;
606 
608  bool is_subset(const Sparsity& rhs) const;
609 
611  Sparsity pattern_inverse() const;
612 
614  bool is_equal(const Sparsity& y) const;
615 
617  bool is_equal(casadi_int y_nrow, casadi_int y_ncol, const std::vector<casadi_int>& y_colind,
618  const std::vector<casadi_int>& y_row) const;
619 
621  bool is_equal(casadi_int y_nrow, casadi_int y_ncol,
622  const casadi_int* y_colind, const casadi_int* y_row) const;
623 
625  bool is_stacked(const Sparsity& y, casadi_int n) const;
626 
628  Sparsity _enlargeRows(casadi_int nrow, const std::vector<casadi_int>& rr, bool ind1) const;
629 
631  Sparsity _enlargeColumns(casadi_int ncol, const std::vector<casadi_int>& cc, bool ind1) const;
632 
634  Sparsity makeDense(std::vector<casadi_int>& mapping) const;
635 
637  Sparsity _erase(const std::vector<casadi_int>& rr, const std::vector<casadi_int>& cc,
638  bool ind1, std::vector<casadi_int>& mapping) const;
639 
641  Sparsity _erase(const std::vector<casadi_int>& rr, bool ind1,
642  std::vector<casadi_int>& mapping) const;
643 
645  Sparsity _appendVector(const SparsityInternal& sp) const;
646 
648  Sparsity _appendColumns(const SparsityInternal& sp) const;
649 
656  Sparsity sub(const std::vector<casadi_int>& rr, const std::vector<casadi_int>& cc,
657  std::vector<casadi_int>& mapping, bool ind1) const;
658 
665  Sparsity sub(const std::vector<casadi_int>& rr, const SparsityInternal& sp,
666  std::vector<casadi_int>& mapping, bool ind1) const;
667 
669  casadi_int get_nz(casadi_int rr, casadi_int cc) const;
670 
672  std::vector<casadi_int> get_nz(const std::vector<casadi_int>& rr,
673  const std::vector<casadi_int>& cc) const;
674 
676  void get_nz(std::vector<casadi_int>& indices) const;
677 
679  bool rowsSequential(bool strictly) const;
680 
687  Sparsity _removeDuplicates(std::vector<casadi_int>& mapping) const;
688 
690  void find(std::vector<casadi_int>& loc, bool ind1) const;
691 
693  std::size_t hash() const;
694 
696  std::string class_name() const override {return "SparsityInternal";}
697 
699  void disp(std::ostream& stream, bool more) const override;
700 
707  Sparsity uni_coloring(const Sparsity& AT, casadi_int cutoff) const;
708 
714  Sparsity star_coloring(casadi_int ordering, casadi_int cutoff) const;
715 
721  Sparsity star_coloring2(casadi_int ordering, casadi_int cutoff) const;
722 
724  std::vector<casadi_int> largest_first() const;
725 
727  Sparsity pmult(const std::vector<casadi_int>& p, bool permute_rows=true, bool permute_cols=true,
728  bool invert_permutation=false) const;
729 
733  void spy(std::ostream &stream) const;
734 
736  void spy_matlab(const std::string& mfile) const;
737 
741  void export_code(const std::string& lang, std::ostream &stream,
742  const Dict& options) const;
743 
745  void spsolve(bvec_t* X, bvec_t* B, bool tr) const;
746 };
747 
748 } // namespace casadi
750 
751 #endif // CASADI_SPARSITY_INTERNAL_HPP
casadi
The casadi namespace.
Definition: binary_mx_impl.hpp:36
casadi::Dict
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.
Definition: generic_type.hpp:258