UnicityTable< T > Class Template Reference

#include <fontinfo.h>

Inheritance diagram for UnicityTable< T >:

Public Member Functions
	UnicityTable ()
	~UnicityTable ()
	Clear the structures and deallocate internal structures. More...
void	reserve (int size)
int	size () const
	Return the size used. More...
const T &	get (int id) const
	Return the object from an id. More...
T *	get_mutable (int id)
int	get_id (T object) const
bool	contains (T object) const
	Return true if T is in the table. More...
T	contains_id (int id) const
	Return true if the id is valid. More...
int	push_back (T object)
	Add an element in the table. More...
void	set_clear_callback (std::function< void(T)> cb)
void	set_compare_callback (std::function< bool(const T &, const T &)> cb)
void	clear ()
void	move (UnicityTable< T > *from)
bool	write (FILE *f, std::function< bool(FILE *, const T &)> cb) const
bool	read (tesseract::TFile *f, std::function< bool(tesseract::TFile *, T *)> cb)

Detailed Description

template<typename T>
class UnicityTable< T >

Definition at line 30 of file fontinfo.h.

Constructor & Destructor Documentation

UnicityTable()

template<typename T >

UnicityTable< T >::UnicityTable

(

)

Definition at line 116 of file unicity_table.h.

                              :
  compare_cb_(nullptr) {
}

~UnicityTable()

template<typename T >

UnicityTable< T >::~UnicityTable

(

)

Clear the structures and deallocate internal structures.

Definition at line 122 of file unicity_table.h.

                               {
  clear();
}

Member Function Documentation

clear()

template<typename T >

void UnicityTable< T >::clear

(

)

Clear the table, calling the callback function if any. All the owned Callbacks are also deleted. If you don't want the Callbacks to be deleted, before calling clear, set the callback to nullptr.

Definition at line 178 of file unicity_table.h.

                            {
  table_.clear();
}

contains()

template<typename T>

bool UnicityTable< T >::contains

(

T

object

)

const

Return true if T is in the table.

Definition at line 162 of file unicity_table.h.

                                             {
  return get_id(object) != -1;
}

contains_id()

template<typename T >

T UnicityTable< T >::contains_id

(

int

id

)

const

Return true if the id is valid.

Definition at line 150 of file unicity_table.h.

                                           {
  return table_.contains_index(id);
}

get()

template<typename T >

const T & UnicityTable< T >::get

(

int

id

)

const

Return the object from an id.

Definition at line 140 of file unicity_table.h.

                                          {
  return table_.get(id);
}

get_id()

template<typename T>

int UnicityTable< T >::get_id

(

T

object

)

const

Return the id of the T object. This method NEEDS a compare_callback to be passed to set_compare_callback.

Definition at line 156 of file unicity_table.h.

                                          {
  return table_.get_index(object);
}

get_mutable()

template<typename T >

T * UnicityTable< T >::get_mutable

(

int

id

)

Definition at line 145 of file unicity_table.h.

                                      {
  return &(table_.get(id));
}

move()

template<typename T>

void UnicityTable< T >::move

(

UnicityTable< T > *

from

)

This method clear the current object, then, does a shallow copy of its argument, and finally invalidate its argument.

Definition at line 185 of file unicity_table.h.

                                                {
  table_.move(&from->table_);
}

push_back()

template<typename T>

int UnicityTable< T >::push_back

(

T

object

)

Add an element in the table.

Definition at line 168 of file unicity_table.h.

                                       {
  int idx = get_id(object);
  if (idx == -1) {
    idx = table_.push_back(object);
  }
  return idx;
}

read()

template<typename T>

bool UnicityTable< T >::read ( tesseract::TFile *  f, std::function< bool(tesseract::TFile *, T *)>  cb  )

inline

Definition at line 96 of file unicity_table.h.

                                                                          {
    return table_.read(f, cb);
  }

reserve()

template<typename T >

void UnicityTable< T >::reserve

(

int

size

)

Reserve some memory. If there is size or more elements, the table will then allocate size * 2 elements.

Definition at line 134 of file unicity_table.h.

                                      {
  table_.reserve(size);
}

set_clear_callback()

template<typename T>

void UnicityTable< T >::set_clear_callback ( std::function< void(T)>  cb )

inline

Add a callback to be called to delete the elements when the table took their ownership.

Definition at line 68 of file unicity_table.h.

                                                   {
    table_.set_clear_callback(cb);
  }

set_compare_callback()

template<typename T>

void UnicityTable< T >::set_compare_callback ( std::function< bool(const T &, const T &)>  cb )

inline

Add a callback to be called to compare the elements when needed (contains, get_id, ...)

Definition at line 74 of file unicity_table.h.

                                                                      {
    table_.set_compare_callback(cb);
    compare_cb_ = cb;
  }

size()

template<typename T >

int UnicityTable< T >::size

(

)

const

Return the size used.

Definition at line 127 of file unicity_table.h.

                               {
  return table_.size();
}

write()

template<typename T>

bool UnicityTable< T >::write ( FILE *  f, std::function< bool(FILE *, const T &)>  cb  ) const

inline

Read/Write the table to a file. This does NOT read/write the callbacks. The Callback given must be permanent since they will be called more than once. The given callback will be deleted at the end. Returns false on read/write error.

Definition at line 93 of file unicity_table.h.

                                                                   {
    return table_.write(f, cb);
  }

---

The documentation for this class was generated from the following files:

• /tesseract/src/ccstruct/fontinfo.h
• /tesseract/src/ccutil/unicity_table.h