Blame include/ceres/internal/manual_constructor.h

Packit ea1746
// Ceres Solver - A fast non-linear least squares minimizer
Packit ea1746
// Copyright 2015 Google Inc. All rights reserved.
Packit ea1746
// http://ceres-solver.org/
Packit ea1746
//
Packit ea1746
// Redistribution and use in source and binary forms, with or without
Packit ea1746
// modification, are permitted provided that the following conditions are met:
Packit ea1746
//
Packit ea1746
// * Redistributions of source code must retain the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer.
Packit ea1746
// * Redistributions in binary form must reproduce the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer in the documentation
Packit ea1746
//   and/or other materials provided with the distribution.
Packit ea1746
// * Neither the name of Google Inc. nor the names of its contributors may be
Packit ea1746
//   used to endorse or promote products derived from this software without
Packit ea1746
//   specific prior written permission.
Packit ea1746
//
Packit ea1746
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Packit ea1746
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit ea1746
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit ea1746
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
Packit ea1746
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
Packit ea1746
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
Packit ea1746
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Packit ea1746
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Packit ea1746
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
Packit ea1746
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Packit ea1746
// POSSIBILITY OF SUCH DAMAGE.
Packit ea1746
//
Packit ea1746
// Author: kenton@google.com (Kenton Varda)
Packit ea1746
//
Packit ea1746
// ManualConstructor statically-allocates space in which to store some
Packit ea1746
// object, but does not initialize it.  You can then call the constructor
Packit ea1746
// and destructor for the object yourself as you see fit.  This is useful
Packit ea1746
// for memory management optimizations, where you want to initialize and
Packit ea1746
// destroy an object multiple times but only allocate it once.
Packit ea1746
//
Packit ea1746
// (When I say ManualConstructor statically allocates space, I mean that
Packit ea1746
// the ManualConstructor object itself is forced to be the right size.)
Packit ea1746
Packit ea1746
#ifndef CERES_PUBLIC_INTERNAL_MANUAL_CONSTRUCTOR_H_
Packit ea1746
#define CERES_PUBLIC_INTERNAL_MANUAL_CONSTRUCTOR_H_
Packit ea1746
Packit ea1746
#include <new>
Packit ea1746
Packit ea1746
namespace ceres {
Packit ea1746
namespace internal {
Packit ea1746
Packit ea1746
// ------- Define CERES_ALIGNED_CHAR_ARRAY --------------------------------
Packit ea1746
Packit ea1746
#ifndef CERES_ALIGNED_CHAR_ARRAY
Packit ea1746
Packit ea1746
// Because MSVC and older GCCs require that the argument to their alignment
Packit ea1746
// construct to be a literal constant integer, we use a template instantiated
Packit ea1746
// at all the possible powers of two.
Packit ea1746
template<int alignment, int size> struct AlignType { };
Packit ea1746
template<int size> struct AlignType<0, size> { typedef char result[size]; };
Packit ea1746
Packit ea1746
#if !defined(CERES_ALIGN_ATTRIBUTE)
Packit ea1746
#define CERES_ALIGNED_CHAR_ARRAY you_must_define_CERES_ALIGNED_CHAR_ARRAY_for_your_compiler
Packit ea1746
#else  // !defined(CERES_ALIGN_ATTRIBUTE)
Packit ea1746
Packit ea1746
#define CERES_ALIGN_TYPE_TEMPLATE(X) \
Packit ea1746
  template<int size> struct AlignType<X, size> { \
Packit ea1746
    typedef CERES_ALIGN_ATTRIBUTE(X) char result[size]; \
Packit ea1746
  }
Packit ea1746
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(1);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(2);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(4);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(8);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(16);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(32);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(64);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(128);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(256);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(512);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(1024);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(2048);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(4096);
Packit ea1746
CERES_ALIGN_TYPE_TEMPLATE(8192);
Packit ea1746
// Any larger and MSVC++ will complain.
Packit ea1746
Packit ea1746
#undef CERES_ALIGN_TYPE_TEMPLATE
Packit ea1746
Packit ea1746
#define CERES_ALIGNED_CHAR_ARRAY(T, Size) \
Packit ea1746
  typename AlignType<CERES_ALIGN_OF(T), sizeof(T) * Size>::result
Packit ea1746
Packit ea1746
#endif  // !defined(CERES_ALIGN_ATTRIBUTE)
Packit ea1746
Packit ea1746
#endif  // CERES_ALIGNED_CHAR_ARRAY
Packit ea1746
Packit ea1746
template <typename Type>
Packit ea1746
class ManualConstructor {
Packit ea1746
 public:
Packit ea1746
  // No constructor or destructor because one of the most useful uses of
Packit ea1746
  // this class is as part of a union, and members of a union cannot have
Packit ea1746
  // constructors or destructors.  And, anyway, the whole point of this
Packit ea1746
  // class is to bypass these.
Packit ea1746
Packit ea1746
  inline Type* get() {
Packit ea1746
    return reinterpret_cast<Type*>(space_);
Packit ea1746
  }
Packit ea1746
  inline const Type* get() const  {
Packit ea1746
    return reinterpret_cast<const Type*>(space_);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  inline Type* operator->() { return get(); }
Packit ea1746
  inline const Type* operator->() const { return get(); }
Packit ea1746
Packit ea1746
  inline Type& operator*() { return *get(); }
Packit ea1746
  inline const Type& operator*() const { return *get(); }
Packit ea1746
Packit ea1746
  // This is needed to get around the strict aliasing warning GCC generates.
Packit ea1746
  inline void* space() {
Packit ea1746
    return reinterpret_cast<void*>(space_);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  // You can pass up to four constructor arguments as arguments of Init().
Packit ea1746
  inline void Init() {
Packit ea1746
    new(space()) Type;
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template <typename T1>
Packit ea1746
  inline void Init(const T1& p1) {
Packit ea1746
    new(space()) Type(p1);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template <typename T1, typename T2>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2) {
Packit ea1746
    new(space()) Type(p1, p2);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template <typename T1, typename T2, typename T3>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3) {
Packit ea1746
    new(space()) Type(p1, p2, p3);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template <typename T1, typename T2, typename T3, typename T4>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template <typename T1, typename T2, typename T3, typename T4, typename T5>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6, typename T7>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6, const T7& p7) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6, p7);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6, typename T7, typename T8>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6, const T7& p7, const T8& p8) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6, p7, p8);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6, typename T7, typename T8, typename T9>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6, const T7& p7, const T8& p8,
Packit ea1746
                   const T9& p9) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6, p7, p8, p9);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6, typename T7, typename T8, typename T9, typename T10>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6, const T7& p7, const T8& p8,
Packit ea1746
                   const T9& p9, const T10& p10) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6, p7, p8, p9, p10);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  template 
Packit ea1746
            typename T6, typename T7, typename T8, typename T9, typename T10,
Packit ea1746
            typename T11>
Packit ea1746
  inline void Init(const T1& p1, const T2& p2, const T3& p3, const T4& p4,
Packit ea1746
                   const T5& p5, const T6& p6, const T7& p7, const T8& p8,
Packit ea1746
                   const T9& p9, const T10& p10, const T11& p11) {
Packit ea1746
    new(space()) Type(p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11);
Packit ea1746
  }
Packit ea1746
Packit ea1746
  inline void Destroy() {
Packit ea1746
    get()->~Type();
Packit ea1746
  }
Packit ea1746
Packit ea1746
 private:
Packit ea1746
  CERES_ALIGNED_CHAR_ARRAY(Type, 1) space_;
Packit ea1746
};
Packit ea1746
Packit ea1746
#undef CERES_ALIGNED_CHAR_ARRAY
Packit ea1746
Packit ea1746
}  // namespace internal
Packit ea1746
}  // namespace ceres
Packit ea1746
Packit ea1746
#endif  // CERES_PUBLIC_INTERNAL_MANUAL_CONSTRUCTOR_H_