vtkSparseArray.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov

#ifndef vtkSparseArray_h
#define vtkSparseArray_h

#include "vtkArrayCoordinates.h"
#include "vtkArraySort.h"
#include "vtkObjectFactory.h"
#include "vtkTypedArray.h"

VTK_ABI_NAMESPACE_BEGIN
template <typename T>
class vtkSparseArray : public vtkTypedArray<T>
{
public:
  vtkTemplateTypeMacro(vtkSparseArray<T>, vtkTypedArray<T>);
  static vtkSparseArray<T>* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  typedef typename vtkArray::CoordinateT CoordinateT;
  typedef typename vtkArray::DimensionT DimensionT;
  typedef typename vtkArray::SizeT SizeT;

  // vtkArray API
  bool IsDense() VTK_FUTURE_CONST override;
  const vtkArrayExtents& GetExtents() VTK_FUTURE_CONST override;
  SizeT GetNonNullSize() VTK_FUTURE_CONST override;
  void GetCoordinatesN(SizeT n, vtkArrayCoordinates& coordinates) VTK_FUTURE_CONST override;
  vtkArray* DeepCopy() override;

  // vtkTypedArray API
  const T& GetValue(CoordinateT i) override;
  const T& GetValue(CoordinateT i, CoordinateT j) override;
  const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k) override;
  const T& GetValue(const vtkArrayCoordinates& coordinates) override;
  const T& GetValueN(SizeT n) override;
  void SetValue(CoordinateT i, const T& value) override;
  void SetValue(CoordinateT i, CoordinateT j, const T& value) override;
  void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value) override;
  void SetValue(const vtkArrayCoordinates& coordinates, const T& value) override;
  void SetValueN(SizeT n, const T& value) override;

  // vtkSparseArray API

  void SetNullValue(const T& value);

  const T& GetNullValue();

  void Clear();

  void Sort(const vtkArraySort& sort);

  std::vector<CoordinateT> GetUniqueCoordinates(DimensionT dimension);

  const CoordinateT* GetCoordinateStorage(DimensionT dimension) const;

  CoordinateT* GetCoordinateStorage(DimensionT dimension);

  const T* GetValueStorage() const;

  T* GetValueStorage();

  void ReserveStorage(SizeT value_count);

  void SetExtentsFromContents();
  void SetExtents(const vtkArrayExtents& extents);


  inline void AddValue(CoordinateT i, const T& value);
  inline void AddValue(CoordinateT i, CoordinateT j, const T& value);
  inline void AddValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value);
  void AddValue(const vtkArrayCoordinates& coordinates, const T& value);

  bool Validate();

protected:
  vtkSparseArray();
  ~vtkSparseArray() override;

private:
  vtkSparseArray(const vtkSparseArray&) = delete;
  void operator=(const vtkSparseArray&) = delete;

  void InternalResize(const vtkArrayExtents& extents) override;
  void InternalSetDimensionLabel(DimensionT i, const vtkStdString& label) override;
  vtkStdString InternalGetDimensionLabel(DimensionT i) VTK_FUTURE_CONST override;

  typedef vtkSparseArray<T> ThisT;

  vtkArrayExtents Extents;

  std::vector<std::string> DimensionLabels;

  std::vector<std::vector<CoordinateT>> Coordinates;

  std::vector<T> Values;


  T NullValue;
};

VTK_ABI_NAMESPACE_END
#include "vtkSparseArray.txx"

#endif
// VTK-HeaderTest-Exclude: vtkSparseArray.h