array_selector.h 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. // Ceres Solver - A fast non-linear least squares minimizer
  2. // Copyright 2023 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: darius.rueckert@fau.de (Darius Rueckert)
  30. //
  31. #ifndef CERES_PUBLIC_INTERNAL_ARRAY_SELECTOR_H_
  32. #define CERES_PUBLIC_INTERNAL_ARRAY_SELECTOR_H_
  33. #include <array>
  34. #include <vector>
  35. #include "ceres/internal/fixed_array.h"
  36. #include "ceres/types.h"
  37. namespace ceres::internal {
  38. // StaticFixedArray selects the best array implementation based on template
  39. // arguments. If the size is not known at compile-time, pass
  40. // ceres::DYNAMIC as a size-template argument.
  41. //
  42. // Three different containers are selected in different scenarios:
  43. //
  44. // num_elements == DYNAMIC:
  45. // -> ceres::internal::FixedArray<T, max_stack_size>(size)
  46. // num_elements != DYNAMIC && num_elements <= max_stack_size
  47. // -> std::array<T,num_elements>
  48. // num_elements != DYNAMIC && num_elements > max_stack_size
  49. // -> std::vector<T>(num_elements)
  50. //
  51. template <typename T,
  52. int num_elements,
  53. int max_num_elements_on_stack,
  54. bool dynamic = (num_elements == DYNAMIC),
  55. bool fits_on_stack = (num_elements <= max_num_elements_on_stack)>
  56. struct ArraySelector {};
  57. template <typename T,
  58. int num_elements,
  59. int max_num_elements_on_stack,
  60. bool fits_on_stack>
  61. struct ArraySelector<T,
  62. num_elements,
  63. max_num_elements_on_stack,
  64. true,
  65. fits_on_stack>
  66. : ceres::internal::FixedArray<T, max_num_elements_on_stack> {
  67. explicit ArraySelector(int s)
  68. : ceres::internal::FixedArray<T, max_num_elements_on_stack>(s) {}
  69. };
  70. template <typename T, int num_elements, int max_num_elements_on_stack>
  71. struct ArraySelector<T, num_elements, max_num_elements_on_stack, false, true>
  72. : std::array<T, num_elements> {
  73. explicit ArraySelector(int s) { CHECK_EQ(s, num_elements); }
  74. };
  75. template <typename T, int num_elements, int max_num_elements_on_stack>
  76. struct ArraySelector<T, num_elements, max_num_elements_on_stack, false, false>
  77. : std::vector<T> {
  78. explicit ArraySelector(int s) : std::vector<T>(s) {
  79. CHECK_EQ(s, num_elements);
  80. }
  81. };
  82. } // namespace ceres::internal
  83. #endif // CERES_PUBLIC_INTERNAL_ARRAY_SELECTOR_H_