BoundaryState.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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.
//============================================================================
#ifndef viskores_exec_BoundaryState_h
#define viskores_exec_BoundaryState_h
 
#include <viskores/Assert.h>
#include <viskores/Math.h>
 
namespace viskores
{
namespace exec
{
 
struct BoundaryState
{
  VISKORES_EXEC
  BoundaryState(const viskores::Id3& ijk, const viskores::Id3& pdims)
    : IJK(ijk)
    , PointDimensions(pdims)
  {
  }
 
  VISKORES_EXEC const viskores::Id3& GetCenterIndex() const { return this->IJK; }
 
  VISKORES_EXEC bool IsRadiusInXBoundary(viskores::IdComponent radius) const
  {
    VISKORES_ASSERT(radius >= 0);
    return (((this->IJK[0] - radius) >= 0) && ((this->IJK[0] + radius) < this->PointDimensions[0]));
  }
  VISKORES_EXEC bool IsRadiusInYBoundary(viskores::IdComponent radius) const
  {
    VISKORES_ASSERT(radius >= 0);
    return (((this->IJK[1] - radius) >= 0) && ((this->IJK[1] + radius) < this->PointDimensions[1]));
  }
  VISKORES_EXEC bool IsRadiusInZBoundary(viskores::IdComponent radius) const
  {
    VISKORES_ASSERT(radius >= 0);
    return (((this->IJK[2] - radius) >= 0) && ((this->IJK[2] + radius) < this->PointDimensions[2]));
  }
 
  VISKORES_EXEC bool IsRadiusInBoundary(viskores::IdComponent radius) const
  {
    return this->IsRadiusInXBoundary(radius) && this->IsRadiusInYBoundary(radius) &&
      this->IsRadiusInZBoundary(radius);
  }
 
  VISKORES_EXEC bool IsNeighborInXBoundary(viskores::IdComponent offset) const
  {
    return (((this->IJK[0] + offset) >= 0) && ((this->IJK[0] + offset) < this->PointDimensions[0]));
  }
  VISKORES_EXEC bool IsNeighborInYBoundary(viskores::IdComponent offset) const
  {
    return (((this->IJK[1] + offset) >= 0) && ((this->IJK[1] + offset) < this->PointDimensions[1]));
  }
  VISKORES_EXEC bool IsNeighborInZBoundary(viskores::IdComponent offset) const
  {
    return (((this->IJK[2] + offset) >= 0) && ((this->IJK[2] + offset) < this->PointDimensions[2]));
  }
 
  VISKORES_EXEC bool IsNeighborInBoundary(const viskores::IdComponent3& neighbor) const
  {
    return this->IsNeighborInXBoundary(neighbor[0]) && this->IsNeighborInYBoundary(neighbor[1]) &&
      this->IsNeighborInZBoundary(neighbor[2]);
  }
 
  VISKORES_EXEC viskores::IdComponent3 MinNeighborIndices(viskores::IdComponent radius) const
  {
    VISKORES_ASSERT(radius >= 0);
    viskores::IdComponent3 minIndices;
 
    for (viskores::IdComponent component = 0; component < 3; ++component)
    {
      if (this->IJK[component] >= radius)
      {
        minIndices[component] = -radius;
      }
      else
      {
        minIndices[component] = static_cast<viskores::IdComponent>(-this->IJK[component]);
      }
    }
 
    return minIndices;
  }
 
  VISKORES_EXEC viskores::IdComponent3 MaxNeighborIndices(viskores::IdComponent radius) const
  {
    VISKORES_ASSERT(radius >= 0);
    viskores::IdComponent3 maxIndices;
 
    for (viskores::IdComponent component = 0; component < 3; ++component)
    {
      if ((this->PointDimensions[component] - this->IJK[component] - 1) >= radius)
      {
        maxIndices[component] = radius;
      }
      else
      {
        maxIndices[component] = static_cast<viskores::IdComponent>(
          this->PointDimensions[component] - this->IJK[component] - 1);
      }
    }
 
    return maxIndices;
  }
 
  VISKORES_EXEC viskores::Id3 NeighborIndexToFullIndexClamp(
    const viskores::IdComponent3& neighbor) const
  {
    viskores::Id3 fullIndex = this->IJK + neighbor;
 
    return viskores::Max(viskores::Id3(0),
                         viskores::Min(this->PointDimensions - viskores::Id3(1), fullIndex));
  }
 
  VISKORES_EXEC viskores::Id3 NeighborIndexToFullIndexClamp(viskores::IdComponent neighborI,
                                                            viskores::IdComponent neighborJ,
                                                            viskores::IdComponent neighborK) const
  {
    return this->NeighborIndexToFullIndexClamp(viskores::make_Vec(neighborI, neighborJ, neighborK));
  }
 
  VISKORES_EXEC viskores::Id3 NeighborIndexToFullIndex(const viskores::IdComponent3& neighbor) const
  {
    return this->IJK + neighbor;
  }
 
  VISKORES_EXEC viskores::Id3 NeighborIndexToFullIndex(viskores::IdComponent neighborI,
                                                       viskores::IdComponent neighborJ,
                                                       viskores::IdComponent neighborK) const
  {
    return this->NeighborIndexToFullIndex(viskores::make_Vec(neighborI, neighborJ, neighborK));
  }
 
  VISKORES_EXEC viskores::IdComponent3 ClampNeighborIndex(
    const viskores::IdComponent3& neighbor) const
  {
    const viskores::Id3 fullIndex = this->IJK + neighbor;
    const viskores::Id3 clampedFullIndex = viskores::Max(
      viskores::Id3(0), viskores::Min(this->PointDimensions - viskores::Id3(1), fullIndex));
    return viskores::IdComponent3{ clampedFullIndex - this->IJK };
  }
 
  VISKORES_EXEC viskores::IdComponent3 ClampNeighborIndex(viskores::IdComponent neighborI,
                                                          viskores::IdComponent neighborJ,
                                                          viskores::IdComponent neighborK) const
  {
    return this->ClampNeighborIndex(viskores::make_Vec(neighborI, neighborJ, neighborK));
  }
 
  VISKORES_EXEC viskores::Id NeighborIndexToFlatIndexClamp(
    const viskores::IdComponent3& neighbor) const
  {
    viskores::Id3 full = this->NeighborIndexToFullIndexClamp(neighbor);
 
    return (full[2] * this->PointDimensions[1] + full[1]) * this->PointDimensions[0] + full[0];
  }
 
  VISKORES_EXEC viskores::Id NeighborIndexToFlatIndexClamp(viskores::IdComponent neighborI,
                                                           viskores::IdComponent neighborJ,
                                                           viskores::IdComponent neighborK) const
  {
    return this->NeighborIndexToFlatIndexClamp(viskores::make_Vec(neighborI, neighborJ, neighborK));
  }
 
  VISKORES_EXEC viskores::Id NeighborIndexToFlatIndex(const viskores::IdComponent3& neighbor) const
  {
    viskores::Id3 full = this->IJK + neighbor;
    return (full[2] * this->PointDimensions[1] + full[1]) * this->PointDimensions[0] + full[0];
  }
 
  VISKORES_EXEC viskores::Id NeighborIndexToFlatIndex(viskores::IdComponent neighborI,
                                                      viskores::IdComponent neighborJ,
                                                      viskores::IdComponent neighborK) const
  {
    return this->NeighborIndexToFlatIndex(viskores::make_Vec(neighborI, neighborJ, neighborK));
  }
 
  viskores::Id3 IJK;
 
  viskores::Id3 PointDimensions;
};
}
} // namespace viskores::exec
 
#endif //viskores_exec_BoundaryState_h