lsst.astshim  21.0.0-2-g45278ab+04719a4bac
MatrixMap.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2017 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #ifndef ASTSHIM_MATRIXMAP_H
23 #define ASTSHIM_MATRIXMAP_H
24 
25 #include <memory>
26 #include <vector>
27 
28 #include "ndarray.h"
29 
30 #include "astshim/base.h"
31 #include "astshim/Mapping.h"
32 
33 namespace ast {
34 
42 class MatrixMap : public Mapping {
43  friend class Object;
44 
45 public:
56  explicit MatrixMap(ConstArray2D const &matrix, std::string const &options = "")
57  : Mapping(reinterpret_cast<AstMapping *>(
58  // form 0 = full matrix, 1 = diagonal elements only
59  astMatrixMap(matrix.getSize<1>(), matrix.getSize<0>(), 0, matrix.getData(), "%s",
60  options.c_str()))) {
61  assertOK();
62  }
63 
73  explicit MatrixMap(std::vector<double> const &diag, std::string const &options = "")
74  : Mapping(reinterpret_cast<AstMapping *>(
75  // form 0 = full matrix, 1 = diagonal elements only
76  astMatrixMap(diag.size(), diag.size(), 1, diag.data(), "%s", options.c_str()))) {
77  assertOK();
78  }
79 
80  virtual ~MatrixMap() {}
81 
83  MatrixMap(MatrixMap const &) = default;
84  MatrixMap(MatrixMap &&) = default;
85  MatrixMap &operator=(MatrixMap const &) = delete;
86  MatrixMap &operator=(MatrixMap &&) = default;
87 
89  std::shared_ptr<MatrixMap> copy() const { return std::static_pointer_cast<MatrixMap>(copyPolymorphic()); }
90 
91 protected:
92  virtual std::shared_ptr<Object> copyPolymorphic() const override {
93  return copyImpl<MatrixMap, AstMatrixMap>();
94  }
95 
97  explicit MatrixMap(AstMatrixMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
98  if (!astIsAMatrixMap(getRawPtr())) {
99  std::ostringstream os;
100  os << "this is a " << getClassName() << ", which is not a MatrixMap";
101  throw std::invalid_argument(os.str());
102  }
103  }
104 };
105 
106 } // namespace ast
107 
108 #endif
Definition: Mapping.h:59
Definition: MatrixMap.h:42
MatrixMap(AstMatrixMap *rawptr)
Construct a MatrixMap from a raw AST pointer.
Definition: MatrixMap.h:97
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: MatrixMap.h:92
MatrixMap & operator=(MatrixMap &&)=default
MatrixMap & operator=(MatrixMap const &)=delete
MatrixMap(ConstArray2D const &matrix, std::string const &options="")
Definition: MatrixMap.h:56
MatrixMap(MatrixMap const &)=default
Copy constructor: make a deep copy.
MatrixMap(MatrixMap &&)=default
MatrixMap(std::vector< double > const &diag, std::string const &options="")
Definition: MatrixMap.h:73
virtual ~MatrixMap()
Definition: MatrixMap.h:80
std::shared_ptr< MatrixMap > copy() const
Return a deep copy of this object.
Definition: MatrixMap.h:89
Definition: Object.h:51
std::string getClassName() const
Definition: Object.h:139
AstObject const * getRawPtr() const
Definition: Object.h:292
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Definition: base.cc:49
ndarray::Array< const double, 2, 2 > ConstArray2D
Definition: base.h:46