Program Listing for File HashMultiset.h

↰ Return to documentation for file (ADS/set/HashMultiset.h)

/*--------------------------------------------------------------------------*/
/*-------------------------- File HashMultiset.h ---------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*----------------------------- DEFINITIONS --------------------------------*/
/*--------------------------------------------------------------------------*/

#ifndef __ADS_HashMultiset
 #define __ADS_HashMultiset
                      /* self-identification: #endif constant */

/*--------------------------------------------------------------------------*/
/*------------------------------ INCLUDES ----------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/Contract.h"
#include "ADS/dictionary/ChainedHashTable.h"

#include <algorithm>
#include <concepts>
#include <cstddef>
#include <functional>
#include <optional>
#include <stdexcept>
#include <utility>
#include <vector>

/*--------------------------------------------------------------------------*/
/*--------------------------- NAMESPACE ------------------------------------*/
/*--------------------------------------------------------------------------*/

namespace ADS {

/*--------------------------------------------------------------------------*/
/*--------------------------- CLASS HashMultiset ---------------------------*/
/*--------------------------------------------------------------------------*/

template< class T , class H = std::hash< T > >
class HashMultiset {

/*--------------------------------------------------------------------------*/
 public:

 using Item = T;

 HashMultiset( void );

 [[nodiscard]] std::size_t size( void ) const;

 [[nodiscard]] std::size_t distinct( void ) const;

 [[nodiscard]] bool empty( void ) const;

 [[nodiscard]] bool contains( const T & x ) const;

 [[nodiscard]] std::size_t count( const T & x ) const;

 void insert( const T & x );

 void remove( const T & x );

 template< class F >
 void forEach( F && f ) const;

/*------------------------- THE STANDARD INTERFACE -------------------------*/

 // a constant view of the pairs ( item , count ) of the distinct items,
 // forward

 using value_type = std::pair< T , std::size_t >;
 using const_iterator =
  typename ChainedHashTable< T , std::size_t , Chain::FRONT , H >::
   const_iterator;
 using iterator = const_iterator;

 [[nodiscard]] const_iterator begin( void ) const {
  return( f_count.begin() );
  }
 [[nodiscard]] const_iterator end( void ) const { return( f_count.end() ); }
 [[nodiscard]] const_iterator cbegin( void ) const { return( begin() ); }
 [[nodiscard]] const_iterator cend( void ) const { return( end() ); }

/*--------------------------------------------------------------------------*/
 private:

 [[nodiscard]] bool counted( void ) const;

 ChainedHashTable< T , std::size_t , Chain::FRONT , H > f_count;
 std::size_t f_size = 0;

 };  // end( class HashMultiset )

/*--------------------------------------------------------------------------*/

}  // end( namespace ADS )

/*--------------------------------------------------------------------------*/
/*-------------------------- IMPLEMENTATION --------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/set/impl/HashMultiset.tpp"

/*--------------------------------------------------------------------------*/

#endif  /* HashMultiset.h included */

/*--------------------------------------------------------------------------*/
/*------------------------ End File HashMultiset.h -------------------------*/
/*--------------------------------------------------------------------------*/