tesseract  4.0.0-1-g2a2b
Public Member Functions | List of all members
UnicityTable< T > Class Template Reference

#include <fontinfo.h>

Inheritance diagram for UnicityTable< T >:
UnicityTableEqEq< 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 (TessCallback1< T > *cb)
 
void set_compare_callback (TessResultCallback2< bool, T const &, T const &> *cb)
 
void clear ()
 
void move (UnicityTable< T > *from)
 
bool write (FILE *f, TessResultCallback2< bool, FILE *, T const &> *cb) const
 
bool read (tesseract::TFile *f, TessResultCallback2< 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 108 of file unicity_table.h.

108  :
109  compare_cb_(nullptr) {
110 }

◆ ~UnicityTable()

template<typename T >
UnicityTable< T >::~UnicityTable ( )

Clear the structures and deallocate internal structures.

Definition at line 114 of file unicity_table.h.

114  {
115  clear();
116 }

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 185 of file unicity_table.h.

185  {
186  table_.clear();
187 }

◆ contains()

template<typename T>
bool UnicityTable< T >::contains ( T  object) const

Return true if T is in the table.

Definition at line 154 of file unicity_table.h.

154  {
155  return get_id(object) != -1;
156 }
UnicityTable::get_id
int get_id(T object) const
Definition: unicity_table.h:148

◆ contains_id()

template<typename T >
T UnicityTable< T >::contains_id ( int  id) const

Return true if the id is valid.

Definition at line 142 of file unicity_table.h.

142  {
143  return table_.contains_index(id);
144 }

◆ get()

template<typename T >
const T & UnicityTable< T >::get ( int  id) const

Return the object from an id.

Definition at line 132 of file unicity_table.h.

132  {
133  return table_.get(id);
134 }

◆ 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 148 of file unicity_table.h.

148  {
149  return table_.get_index(object);
150 }

◆ get_mutable()

template<typename T >
T * UnicityTable< T >::get_mutable ( int  id)

Definition at line 137 of file unicity_table.h.

137  {
138  return &(table_.get(id));
139 }

◆ 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 204 of file unicity_table.h.

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

◆ push_back()

template<typename T>
int UnicityTable< T >::push_back ( T  object)

Add an element in the table.

Definition at line 160 of file unicity_table.h.

160  {
161  int idx = get_id(object);
162  if (idx == -1) {
163  idx = table_.push_back(object);
164  }
165  return idx;
166 }
UnicityTable::get_id
int get_id(T object) const
Definition: unicity_table.h:148

◆ read()

template<typename T>
bool UnicityTable< T >::read ( tesseract::TFile *  f,
TessResultCallback2< bool, tesseract::TFile *, T *> *  cb 
)

Definition at line 196 of file unicity_table.h.

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

◆ 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 126 of file unicity_table.h.

126  {
127  table_.reserve(size);
128 }
UnicityTable::size
int size() const
Return the size used.
Definition: unicity_table.h:119

◆ set_clear_callback()

template<typename T>
void UnicityTable< T >::set_clear_callback ( TessCallback1< T > *  cb)

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

Definition at line 171 of file unicity_table.h.

171  {
172  table_.set_clear_callback(cb);
173 }

◆ set_compare_callback()

template<typename T>
void UnicityTable< T >::set_compare_callback ( TessResultCallback2< bool, T const &, T const &> *  cb)

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

Definition at line 178 of file unicity_table.h.

178  {
179  table_.set_compare_callback(cb);
180  compare_cb_ = cb;
181 }

◆ size()

template<typename T >
int UnicityTable< T >::size ( ) const

Return the size used.

Definition at line 119 of file unicity_table.h.

119  {
120  return table_.size();
121 }

◆ write()

template<typename T>
bool UnicityTable< T >::write ( FILE *  f,
TessResultCallback2< bool, FILE *, T const &> *  cb 
) const

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 190 of file unicity_table.h.

191  {
192  return table_.write(f, cb);
193 }
The documentation for this class was generated from the following files: