vtkSparseArray.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkSparseArray.h
 
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkSparseArray_h
#define vtkSparseArray_h
 
#include "vtkArrayCoordinates.h"
#include "vtkArraySort.h"
#include "vtkObjectFactory.h"
#include "vtkTypeTemplate.h"
#include "vtkTypedArray.h"
 
template<typename T>
class vtkSparseArray :
  public vtkTypeTemplate<vtkSparseArray<T>, vtkTypedArray<T> >
{
public:
  static vtkSparseArray<T>* New();
  void PrintSelf(ostream &os, vtkIndent indent);
 
  typedef typename vtkArray::CoordinateT CoordinateT;
  typedef typename vtkArray::DimensionT DimensionT;
  typedef typename vtkArray::SizeT SizeT;
 
  // vtkArray API
  bool IsDense();
  const vtkArrayExtents& GetExtents();
  SizeT GetNonNullSize();
  void GetCoordinatesN(const SizeT n, vtkArrayCoordinates& coordinates);
  vtkArray* DeepCopy();
 
  // vtkTypedArray API
  const T& GetValue(CoordinateT i);
  const T& GetValue(CoordinateT i, CoordinateT j);
  const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k);
  const T& GetValue(const vtkArrayCoordinates& coordinates);
  const T& GetValueN(const SizeT n);
  void SetValue(CoordinateT i, const T& value);
  void SetValue(CoordinateT i, CoordinateT j, const T& value);
  void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value);
  void SetValue(const vtkArrayCoordinates& coordinates, const T& value);
  void SetValueN(const SizeT n, const T& value);
 
  // 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(const 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();
 
private:
  vtkSparseArray(const vtkSparseArray&); // Not implemented
  void operator=(const vtkSparseArray&); // Not implemented
 
  void InternalResize(const vtkArrayExtents& extents);
  void InternalSetDimensionLabel(DimensionT i, const vtkStdString& label);
  vtkStdString InternalGetDimensionLabel(DimensionT i);
 
  typedef vtkSparseArray<T> ThisT;
 
  vtkArrayExtents Extents;
 
  std::vector<vtkStdString> DimensionLabels;
 
  std::vector<std::vector<CoordinateT> > Coordinates;
 
  std::vector<T> Values;
 
 
  T NullValue;
};
 
#include "vtkSparseArray.txx"
 
#endif
// VTK-HeaderTest-Exclude: vtkSparseArray.h