libigl/include/igl/default_num_threads.h

// This file is part of libigl, a simple c++ geometry processing library.
//
// Copyright (C) 2021 Jérémie Dumas <[email protected]>
//
// This Source Code Form is subject to the terms of the Mozilla Public License
// v. 2.0. If a copy of the MPL was not distributed with this file, You can
// obtain one at http://mozilla.org/MPL/2.0/.
#ifndef IGL_DEFAULT_NUM_THREADS_H
#define IGL_DEFAULT_NUM_THREADS_H
#include "igl_inline.h"

namespace igl
{
  ///
  /// Returns the default number of threads used in libigl. The value returned by the first call to
  /// this function is cached. The following strategy is used to determine the default number of
  /// threads:
  /// 1. User-provided argument force_num_threads if != 0.
  /// 2. Environment variable IGL_NUM_THREADS if > 0.
  /// 3. Hardware concurrency if != 0.
  /// 4. A fallback value of 8 is used otherwise.
  ///
  /// @note       It is safe to call this method from multiple threads.
  ///
  /// @param[in]  force_num_threads  User-provided default value.
  ///
  /// @return     Default number of threads.
  ///
  IGL_INLINE unsigned int default_num_threads(unsigned int force_num_threads = 0);
}

#ifndef IGL_STATIC_LIBRARY
#include "default_num_threads.cpp"
#endif

#endif