itkEquivalencyTable.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkEquivalencyTable_h
#define __itkEquivalencyTable_h


#include "itkProcessObject.h"
#include "itksys/hash_map.hxx"

namespace itk
{
class ITKCommon_EXPORT EquivalencyTable:public DataObject
{
public:
  typedef EquivalencyTable           Self;
  typedef DataObject                 Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
  itkNewMacro(Self);
  itkTypeMacro(EquivalencyTable, DataObject);

  typedef itksys::hash_map< unsigned long, unsigned long,
    itksys::hash< unsigned long > > HashTableType;

  typedef HashTableType::iterator       Iterator;
  typedef HashTableType::const_iterator ConstIterator;
  typedef HashTableType::value_type     ValueType;

  void Flatten();

  bool Add(unsigned long a, unsigned long b);

  bool AddAndFlatten(unsigned long a, unsigned long b);

  unsigned long Lookup(const unsigned long a) const
  {
    ConstIterator result = m_HashMap.find(a);

    if ( result == m_HashMap.end() ) { return a; }
    else { return ( *result ).second; }
  }

  unsigned long RecursiveLookup(const unsigned long a) const;

  bool IsEntry(const unsigned long a) const
  {
    if ( m_HashMap.find(a) == m_HashMap.end() ) { return false; }
    else { return true; }
  }

  void Erase(const unsigned long a)
  {  m_HashMap.erase(a); }

  void Clear()
  {  m_HashMap.clear();    }

  bool Empty() const
  { return m_HashMap.empty();    }

  HashTableType::size_type Size() const
  { return m_HashMap.size(); }

  Iterator Begin() { return m_HashMap.begin(); }

  Iterator End()   { return m_HashMap.end();   }

  //  void PrintHashTable();

protected:
  EquivalencyTable()  {}
  virtual ~EquivalencyTable() {}
  EquivalencyTable(const Self &); // purposely not implemented
  void operator=(const Self &);   // purposely not implemented

  void PrintSelf(std::ostream & os, Indent indent) const;

  HashTableType m_HashMap;
};
} // end namespace itk

#endif