mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-20 19:15:45 +00:00
59 lines
2.3 KiB
C
59 lines
2.3 KiB
C
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//
|
|
// Copyright 2014 Sandia Corporation.
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// the U.S. Government retains certain rights in this software.
|
|
//
|
|
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
|
// Laboratory (LANL), the U.S. Government retains certain rights in
|
|
// this software.
|
|
//============================================================================
|
|
#ifndef vtk_m_internal_Assume_h
|
|
#define vtk_m_internal_Assume_h
|
|
|
|
|
|
#include <vtkm/Assert.h>
|
|
|
|
// Description:
|
|
// VTKM_ASSUME instructs the compiler that a certain non-obvious condition will
|
|
// *always* be true. Beware that if cond is false at runtime, the results are
|
|
// unpredictable (and likely catastrophic). A runtime assertion is added so
|
|
// that debugging builds may easily catch violations of the condition.
|
|
//
|
|
// A useful application of this macro is when a method is passed in a
|
|
// vtkm::Vec that is uninitialized and conditional fills the vtkm::Vec
|
|
// based on other runtime information such as cell type. This allows you to
|
|
// assert that only valid cell types will be used, producing more efficient
|
|
// code.
|
|
//
|
|
#define VTKM_ASSUME(cond) \
|
|
do { \
|
|
const bool c = cond; \
|
|
VTKM_ASSERT("Bad assumption in VTKM_ASSUME: " #cond && c); \
|
|
VTKM_ASSUME_IMPL(c); \
|
|
(void)c; /* Prevents unused var warnings */ \
|
|
} while (false) /* do-while prevents extra semicolon warnings */
|
|
|
|
// VTKM_ASSUME_IMPL is compiler-specific:
|
|
#if defined(VTKM_MSVC) || defined(VTKM_ICC)
|
|
# define VTKM_ASSUME_IMPL(cond) __assume(cond)
|
|
#elif defined(VTKM_GCC) && ( __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) )
|
|
// Added in 4.5.0:
|
|
# define VTKM_ASSUME_IMPL(cond) if (!(cond)) __builtin_unreachable()
|
|
#elif defined(VTKM_CLANG)
|
|
# define VTKM_ASSUME_IMPL(cond) if (!(cond)) __builtin_unreachable()
|
|
#else
|
|
# define VTKM_ASSUME_IMPL(cond) do {} while (false) /* no-op */
|
|
#endif
|
|
|
|
#endif // vtk_m_internal_Assume_h
|