LSSTApplications  20.0.0
LSSTDataManagementBasePackage
ChebyMap.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_CHEBYMAP_H
23 #define ASTSHIM_CHEBYMAP_H
24 
25 #include <algorithm>
26 #include <memory>
27 #include <vector>
28 
29 #include "astshim/base.h"
30 #include "astshim/Mapping.h"
31 
32 namespace ast {
33 
37 class ChebyDomain {
38 public:
48 };
49 
97 class ChebyMap : public Mapping {
98  friend class Object;
99 
100 public:
161  explicit ChebyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i,
162  std::vector<double> const &lbnd_f, std::vector<double> const &ubnd_f,
163  std::vector<double> const &lbnd_i, std::vector<double> const &ubnd_i,
164  std::string const &options = "")
165  : Mapping(reinterpret_cast<AstMapping *>(
166  _makeRawChebyMap(coeff_f, coeff_i, lbnd_f, ubnd_f, lbnd_i, ubnd_i, options))) {}
167 
184  explicit ChebyMap(ConstArray2D const &coeff_f, int nout, std::vector<double> const &lbnd_f,
185  std::vector<double> const &ubnd_f, std::string const &options = "IterInverse=0")
186  : Mapping(reinterpret_cast<AstMapping *>(
187  _makeRawChebyMap(coeff_f, nout, lbnd_f, ubnd_f, options))) {}
188 
189  virtual ~ChebyMap() {}
190 
192  ChebyMap(ChebyMap const &) = default;
193  ChebyMap(ChebyMap &&) = default;
194  ChebyMap &operator=(ChebyMap const &) = delete;
195  ChebyMap &operator=(ChebyMap &&) = default;
196 
198  std::shared_ptr<ChebyMap> copy() const { return std::static_pointer_cast<ChebyMap>(copyPolymorphic()); }
199 
214  ChebyDomain getDomain(bool forward) const;
215 
297  ChebyMap polyTran(bool forward, double acc, double maxacc, int maxorder, std::vector<double> const &lbnd,
298  std::vector<double> const &ubnd) const;
299 
304  ChebyMap polyTran(bool forward, double acc, double maxacc, int maxorder) const;
305 
306 protected:
307  virtual std::shared_ptr<Object> copyPolymorphic() const override {
308  return copyImpl<ChebyMap, AstChebyMap>();
309  }
310 
312  ChebyMap(AstChebyMap *map);
313 
314 private:
316  AstChebyMap *_makeRawChebyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i,
317  std::vector<double> const &lbnd_f, std::vector<double> const &ubnd_f,
318  std::vector<double> const &lbnd_i, std::vector<double> const &ubnd_i,
319  std::string const &options = "") const;
320 
322  AstChebyMap *_makeRawChebyMap(ConstArray2D const &coeff_f, int nout, std::vector<double> const &lbnd_f,
323  std::vector<double> const &ubnd_f, std::string const &options = "") const;
324 };
325 
326 } // namespace ast
327 
328 #endif
std::string
STL class.
std::shared_ptr
STL class.
std::vector< double >
ast::ChebyDomain::ChebyDomain
ChebyDomain(std::vector< double > const &lbnd, std::vector< double > const &ubnd)
Construct a ChebyDomain.
Definition: ChebyMap.h:45
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
base.h
ast::ChebyMap::copy
std::shared_ptr< ChebyMap > copy() const
Return a deep copy of this object.
Definition: ChebyMap.h:198
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::ChebyDomain::ubnd
std::vector< double > const ubnd
upper bound of domain (one element per axis)
Definition: ChebyMap.h:47
ast::ChebyMap::polyTran
ChebyMap polyTran(bool forward, double acc, double maxacc, int maxorder, std::vector< double > const &lbnd, std::vector< double > const &ubnd) const
This function creates a new ChebyMap which is a copy of this one, in which a specified transformation...
Definition: ChebyMap.cc:30
ast::ChebyMap::ChebyMap
ChebyMap(ChebyMap &&)=default
ast::ChebyMap::operator=
ChebyMap & operator=(ChebyMap &&)=default
ast::ChebyMap::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: ChebyMap.h:307
ast::ChebyMap::ChebyMap
ChebyMap(ChebyMap const &)=default
Copy constructor: make a deep copy.
ast::ChebyMap
A ChebyMap is a form of Mapping which performs a Chebyshev polynomial transformation.
Definition: ChebyMap.h:97
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
ast::ChebyMap::getDomain
ChebyDomain getDomain(bool forward) const
Return the bounding box of the domain of a ChebyMap.
Definition: ChebyMap.cc:57
Mapping.h
ast::ChebyMap::ChebyMap
ChebyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i, std::vector< double > const &lbnd_f, std::vector< double > const &ubnd_f, std::vector< double > const &lbnd_i, std::vector< double > const &ubnd_i, std::string const &options="")
Construct a ChebyMap with a specified forward and/or inverse transforms.
Definition: ChebyMap.h:161
ast::ChebyMap::operator=
ChebyMap & operator=(ChebyMap const &)=delete
ast::ChebyMap::~ChebyMap
virtual ~ChebyMap()
Definition: ChebyMap.h:189
ast::ChebyDomain
The domain over which a Chebyshev polynomial is defined; returned by ChebyMap.getDomain.
Definition: ChebyMap.h:37
ast::ChebyDomain::lbnd
std::vector< double > const lbnd
lower bound of domain (one element per axis)
Definition: ChebyMap.h:46
ast::ConstArray2D
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition: base.h:46
ast::ChebyMap::ChebyMap
ChebyMap(ConstArray2D const &coeff_f, int nout, std::vector< double > const &lbnd_f, std::vector< double > const &ubnd_f, std::string const &options="IterInverse=0")
Construct a ChebyMap with only the forward transform specified.
Definition: ChebyMap.h:184