vtkTuple.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkTuple_h
#define vtkTuple_h
 
#include "vtkIOStream.h" // For streaming operators
#include "vtkSystemIncludes.h"
 
#include <algorithm> // for std::copy
#include <array>     // for std::array
#include <cassert>   // For inline assert for bounds checked methods.
#include <cmath>     // for std::abs() with float overloads
#include <cstdlib>   // for std::abs() with int overloads
 
VTK_ABI_NAMESPACE_BEGIN
template <typename T, int Size>
class vtkTuple
{
public:
  vtkTuple() = default;
 
  explicit vtkTuple(const T& scalar)
  {
    for (int i = 0; i < Size; ++i)
    {
      this->Data[i] = scalar;
    }
  }
 
  explicit vtkTuple(const T* init)
  {
    for (int i = 0; i < Size; ++i)
    {
      this->Data[i] = init[i];
    }
  }
 
  explicit vtkTuple(const std::array<T, Size>& values)
  {
    std::copy(values.begin(), values.end(), this->Data);
  }
 
  int GetSize() const { return Size; }
 
  T* GetData() { return this->Data; }
  const T* GetData() const { return this->Data; }
 
  T& operator[](int i) { return this->Data[i]; }
  const T& operator[](int i) const { return this->Data[i]; }
 
 
  T operator()(int i) const
  {
    assert("pre: index_in_bounds" && i >= 0 && i < Size);
    return this->Data[i];
  }
 
 
  bool Compare(const vtkTuple<T, Size>& other, const T& tol) const
  {
    if (Size != other.GetSize())
    {
      return false;
    }
    for (int i = 0; i < Size; ++i)
    {
      if (std::abs(this->Data[i] - other.Data[i]) >= tol)
      {
        return false;
      }
    }
    return true;
  }
 
 
  template <typename TR>
  vtkTuple<TR, Size> Cast() const
  {
    vtkTuple<TR, Size> result;
    for (int i = 0; i < Size; ++i)
    {
      result[i] = static_cast<TR>(this->Data[i]);
    }
    return result;
  }
 
protected:
 
  T Data[Size];
};
 
 
template <typename A, int Size>
ostream& operator<<(ostream& out, const vtkTuple<A, Size>& t)
{
  out << "(";
  bool first = true;
  for (int i = 0; i < Size; ++i)
  {
    if (first)
    {
      first = false;
    }
    else
    {
      out << ", ";
    }
    out << t[i];
  }
  out << ")";
  return out;
}
// Specialize for unsigned char so that we can see the numbers!
template <int Size>
ostream& operator<<(ostream& out, const vtkTuple<unsigned char, Size>& t)
{
  out << "(";
  bool first = true;
  for (int i = 0; i < Size; ++i)
  {
    if (first)
    {
      first = false;
    }
    else
    {
      out << ", ";
    }
    out << static_cast<int>(t[i]);
  }
  out << ")";
  return out;
}
 
 
template <typename A, int Size>
bool operator==(const vtkTuple<A, Size>& t1, const vtkTuple<A, Size>& t2)
{
  for (int i = 0; i < Size; ++i)
  {
    if (t1[i] != t2[i])
    {
      return false;
    }
  }
  return true;
}
 
template <typename A, int Size>
bool operator!=(const vtkTuple<A, Size>& t1, const vtkTuple<A, Size>& t2)
{
  return !(t1 == t2);
}
 
VTK_ABI_NAMESPACE_END
#endif // vtkTuple_h
// VTK-HeaderTest-Exclude: vtkTuple.h