parallel_vector_ops.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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. // Authors: vitus@google.com (Michael Vitus),
  30. // dmitriy.korchemkin@gmail.com (Dmitriy Korchemkin)
  31. #ifndef CERES_INTERNAL_PARALLEL_VECTOR_OPS_H_
  32. #define CERES_INTERNAL_PARALLEL_VECTOR_OPS_H_
  33. #include <mutex>
  34. #include <vector>
  35. #include "ceres/context_impl.h"
  36. #include "ceres/internal/eigen.h"
  37. #include "ceres/internal/export.h"
  38. #include "ceres/parallel_for.h"
  39. namespace ceres::internal {
  40. // Lower bound on block size for parallel vector operations.
  41. // Operations with vectors of less than kMinBlockSizeParallelVectorOps elements
  42. // will be executed in a single thread.
  43. constexpr int kMinBlockSizeParallelVectorOps = 1 << 16;
  44. // Evaluate vector expression in parallel
  45. // Assuming LhsExpression and RhsExpression are some sort of column-vector
  46. // expression, assignment lhs = rhs is eavluated over a set of contiguous blocks
  47. // in parallel. This is expected to work well in the case of vector-based
  48. // expressions (since they typically do not result into temporaries). This
  49. // method expects lhs to be size-compatible with rhs
  50. template <typename LhsExpression, typename RhsExpression>
  51. void ParallelAssign(ContextImpl* context,
  52. int num_threads,
  53. LhsExpression& lhs,
  54. const RhsExpression& rhs) {
  55. static_assert(LhsExpression::ColsAtCompileTime == 1);
  56. static_assert(RhsExpression::ColsAtCompileTime == 1);
  57. CHECK_EQ(lhs.rows(), rhs.rows());
  58. const int num_rows = lhs.rows();
  59. ParallelFor(
  60. context,
  61. 0,
  62. num_rows,
  63. num_threads,
  64. [&lhs, &rhs](const std::tuple<int, int>& range) {
  65. auto [start, end] = range;
  66. lhs.segment(start, end - start) = rhs.segment(start, end - start);
  67. },
  68. kMinBlockSizeParallelVectorOps);
  69. }
  70. // Set vector to zero using num_threads
  71. template <typename VectorType>
  72. void ParallelSetZero(ContextImpl* context,
  73. int num_threads,
  74. VectorType& vector) {
  75. ParallelSetZero(context, num_threads, vector.data(), vector.rows());
  76. }
  77. void ParallelSetZero(ContextImpl* context,
  78. int num_threads,
  79. double* values,
  80. int num_values);
  81. } // namespace ceres::internal
  82. #endif // CERES_INTERNAL_PARALLEL_FOR_H_