LSSTApplications  18.1.0
LSSTDataManagementBasePackage
arrays.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 #ifndef AFW_TABLE_arrays_h_INCLUDED
24 #define AFW_TABLE_arrays_h_INCLUDED
25 
26 #include "lsst/utils/hashCombine.h"
27 
29 #include "lsst/afw/table/Schema.h"
30 
31 namespace lsst {
32 namespace afw {
33 namespace table {
34 
42 template <typename T>
43 class ArrayKey : public FunctorKey<ndarray::Array<T const, 1, 1> >,
44  public ReferenceFunctorKey<ndarray::ArrayRef<T, 1, 1> >,
45  public ConstReferenceFunctorKey<ndarray::ArrayRef<T const, 1, 1> > {
46 public:
61  static ArrayKey addFields(Schema& schema, std::string const& name, std::string const& doc,
62  std::string const& unit, std::vector<T> const& docData);
63 
74  static ArrayKey addFields(Schema& schema, std::string const& name, std::string const& doc,
75  std::string const& unit, int size);
76 
78  ArrayKey() noexcept : _begin(), _size(0) {}
79 
81  explicit ArrayKey(std::vector<Key<T> > const& keys);
82 
89  explicit ArrayKey(Key<Array<T> > const& other) noexcept;
90 
99  ArrayKey(SubSchema const& s);
100 
101  ArrayKey(ArrayKey const&) noexcept;
102  ArrayKey(ArrayKey&&) noexcept;
103  ArrayKey& operator=(ArrayKey const&) noexcept;
104  ArrayKey& operator=(ArrayKey&&) noexcept;
105  ~ArrayKey() noexcept override;
106 
108  int getSize() const noexcept { return _size; }
109 
111  ndarray::Array<T const, 1, 1> get(BaseRecord const& record) const override;
112 
114  void set(BaseRecord& record, ndarray::Array<T const, 1, 1> const& value) const override;
115 
117  ndarray::ArrayRef<T, 1, 1> getReference(BaseRecord& record) const override;
118 
120  ndarray::ArrayRef<T const, 1, 1> getConstReference(BaseRecord const& record) const override;
121 
123  bool operator==(ArrayKey<T> const& other) const noexcept {
125  return other._begin == _begin && other._size == _size;
126  }
127  bool operator!=(ArrayKey<T> const& other) const noexcept { return !operator==(other); }
129 
131  std::size_t hash_value() const noexcept {
132  // Completely arbitrary seed
133  return utils::hashCombine(17, _begin, _size);
134  }
135 
137  bool isValid() const noexcept { return _begin.isValid(); }
138 
140  Key<T> operator[](int i) const;
141 
143  ArrayKey slice(int begin, int end) const;
144 
145 private:
146  ArrayKey(Key<T> const& begin, int size) noexcept : _begin(begin), _size(size) {}
147 
148  Key<T> _begin;
149  int _size;
150 };
151 } // namespace table
152 } // namespace afw
153 } // namespace lsst
154 
155 namespace std {
156 template <typename T>
160  size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
161 };
162 } // namespace std
163 
164 #endif // !AFW_TABLE_arrays_h_INCLUDED
Defines the fields and offsets for a table.
Definition: Schema.h:50
afw::table::Key< afw::table::Array< Scalar > > ArrayKey
Typedefs to be used for probability and parameter values.
Definition: common.h:48
A FunctorKey used to get or set a ndarray::Array from a sequence of scalar Keys.
Definition: arrays.h:43
A proxy type for name lookups in a Schema.
Definition: Schema.h:360
~ArrayKey() noexcept override
ArrayKey & operator=(ArrayKey const &) noexcept
STL namespace.
ArrayKey slice(int begin, int end) const
Return a FunctorKey corresponding to a range of elements.
Definition: arrays.cc:143
Key< T > operator[](int i) const
Return a scalar Key for an element of the array.
Definition: arrays.cc:135
ArrayKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to. ...
Definition: arrays.h:78
STL class.
ndarray::ArrayRef< T const, 1, 1 > getConstReference(BaseRecord const &record) const override
Get const reference array from the given record.
Definition: arrays.cc:129
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: arrays.h:131
ndarray::ArrayRef< T, 1, 1 > getReference(BaseRecord &record) const override
Get non-const reference array from the given record.
Definition: arrays.cc:123
A base class for image defects.
Base class for objects that can return a const reference to part of a record, but are not a true Key...
Definition: FunctorKey.h:109
table::Schema schema
Definition: Camera.cc:161
Tag types used to declare specialized field types.
Definition: misc.h:32
bool operator!=(ArrayKey< T > const &other) const noexcept
Compare the FunctorKey for equality with another, using the underlying scalar Keys.
Definition: arrays.h:127
solver_t * s
Base class for objects that can return a non-const reference to part of a record, but are not a true ...
Definition: FunctorKey.h:91
STL class.
Base class for all records.
Definition: BaseRecord.h:31
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
int getSize() const noexcept
Return the number of elements in the array.
Definition: arrays.h:108
ItemVariant const * other
Definition: Schema.cc:56
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
int end
bool isValid() const noexcept
Return True if the FunctorKey contains valid scalar keys.
Definition: arrays.h:137
bool operator==(ArrayKey< T > const &other) const noexcept
Compare the FunctorKey for equality with another, using the underlying scalar Keys.
Definition: arrays.h:124
static ArrayKey addFields(Schema &schema, std::string const &name, std::string const &doc, std::string const &unit, std::vector< T > const &docData)
Add an array of fields to a Schema, and return an ArrayKey that points to them.
Definition: arrays.cc:35
size_t operator()(argument_type const &obj) const noexcept
Definition: arrays.h:160