include/ceres/internal/port.h

   1 // Ceres Solver - A fast non-linear least squares minimizer
   2 // Copyright 2015 Google Inc. All rights reserved.
   3 // http://ceres-solver.org/
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are met:
   7 //
   8 // * Redistributions of source code must retain the above copyright notice,
   9 //   this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright notice,
  11 //   this list of conditions and the following disclaimer in the documentation
  12 //   and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors may be
  14 //   used to endorse or promote products derived from this software without
  15 //   specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 // POSSIBILITY OF SUCH DAMAGE.
  28 //
  29 // Author: keir@google.com (Keir Mierle)
  30
  31 #ifndef CERES_PUBLIC_INTERNAL_PORT_H_
  32 #define CERES_PUBLIC_INTERNAL_PORT_H_
  33
  34 // This file needs to compile as c code.
  35 #ifdef __cplusplus
  36 #include <cstddef>
  37 #include "ceres/internal/config.h"
  38 #if defined(CERES_TR1_MEMORY_HEADER)
  39 #include <tr1/memory>
  40 #else
  41 #include <memory>
  42 #endif
  43
  44 namespace ceres {
  45
  46 #if defined(CERES_TR1_SHARED_PTR)
  47 using std::tr1::shared_ptr;
  48 #else
  49 using std::shared_ptr;
  50 #endif
  51
  52 // We allocate some Eigen objects on the stack and other places they
  53 // might not be aligned to X(=16 [SSE], 32 [AVX] etc)-byte boundaries.  If we
  54 // have C++11, we can specify their alignment (which is desirable, as it means
  55 // we can safely enable vectorisation on matrices).  However, the standard gives
  56 // wide lattitude as to what alignments are legal.  It must be the case that
  57 // alignments up to alignof(std::max_align_t) are valid, but this might be < 16
  58 // on some platforms, in which case even if using C++11, on these platforms
  59 // we should not attempt to align to X-byte boundaries.  If using < C++11,
  60 // we cannot specify the alignment.
  61 #ifdef CERES_USE_CXX11
  62 namespace port_constants {
  63 static constexpr size_t kMaxAlignBytes =
  64     // Work around a GCC 4.8 bug
  65     // (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56019) where
  66     // std::max_align_t is misplaced.
  67 #if defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 8
  68     alignof(::max_align_t);
  69 #else
  70     alignof(std::max_align_t);
  71 #endif
  72 }  // namespace port_constants
  73 #endif
  74
  75 }  // namespace ceres
  76
  77 #endif  // __cplusplus
  78
  79 // A macro to signal which functions and classes are exported when
  80 // building a DLL with MSVC.
  81 //
  82 // Note that the ordering here is important, CERES_BUILDING_SHARED_LIBRARY
  83 // is only defined locally when Ceres is compiled, it is never exported to
  84 // users.  However, in order that we do not have to configure config.h
  85 // separately for building vs installing, if we are using MSVC and building
  86 // a shared library, then both CERES_BUILDING_SHARED_LIBRARY and
  87 // CERES_USING_SHARED_LIBRARY will be defined when Ceres is compiled.
  88 // Hence it is important that the check for CERES_BUILDING_SHARED_LIBRARY
  89 // happens first.
  90 #if defined(_MSC_VER) && defined(CERES_BUILDING_SHARED_LIBRARY)
  91 # define CERES_EXPORT __declspec(dllexport)
  92 #elif defined(_MSC_VER) && defined(CERES_USING_SHARED_LIBRARY)
  93 # define CERES_EXPORT __declspec(dllimport)
  94 #else
  95 # define CERES_EXPORT
  96 #endif
  97
  98 #endif  // CERES_PUBLIC_INTERNAL_PORT_H_