tesseract::CLIST Class Reference

#include <clst.h>

Inheritance diagram for tesseract::CLIST:

Public Member Functions
	~CLIST ()
void	internal_deep_clear (void(*zapper)(void *))
void	shallow_clear ()
bool	empty () const
bool	singleton () const
void	shallow_copy (CLIST *from_list)
void	assign_to_sublist (CLIST_ITERATOR *start_it, CLIST_ITERATOR *end_it)
int32_t	length () const
void	sort (int comparator(const void *, const void *))
bool	add_sorted (int comparator(const void *, const void *), bool unique, void *new_data)
void	set_subtract (int comparator(const void *, const void *), bool unique, CLIST *minuend, CLIST *subtrahend)

Friends
class	CLIST_ITERATOR

Detailed Description

Definition at line 64 of file clst.h.

Constructor & Destructor Documentation

~CLIST()

tesseract::CLIST::~CLIST ( )

inline

Definition at line 79 of file clst.h.

           { // destructor
    shallow_clear();
  }

Member Function Documentation

add_sorted()

bool tesseract::CLIST::add_sorted	(	int	comparatorconst void *, const void *,
		bool	unique,
		void *	new_data
	)

Definition at line 138 of file clst.cpp.

                                                                                              {
  // Check for adding at the end.
  if (last == nullptr || comparator(&last->data, &new_data) < 0) {
    auto *new_element = new CLIST_LINK;
    new_element->data = new_data;
    if (last == nullptr) {
      new_element->next = new_element;
    } else {
      new_element->next = last->next;
      last->next = new_element;
    }
    last = new_element;
    return true;
  } else if (!unique || last->data != new_data) {
    // Need to use an iterator.
    CLIST_ITERATOR it(this);
    for (it.mark_cycle_pt(); !it.cycled_list(); it.forward()) {
      void *data = it.data();
      if (data == new_data && unique) {
        return false;
      }
      if (comparator(&data, &new_data) > 0) {
        break;
      }
    }
    if (it.cycled_list()) {
      it.add_to_end(new_data);
    } else {
      it.add_before_then_move(new_data);
    }
    return true;
  }
  return false;
}

assign_to_sublist()

void tesseract::CLIST::assign_to_sublist	(	CLIST_ITERATOR *	start_it,
		CLIST_ITERATOR *	end_it
	)

Definition at line 86 of file clst.cpp.

                            {  // from list end
  constexpr ERRCODE LIST_NOT_EMPTY("Destination list must be empty before extracting a sublist");
 
  if (!empty()) {
    LIST_NOT_EMPTY.error("CLIST.assign_to_sublist", ABORT);
  }
 
  last = start_it->extract_sublist(end_it);
}

empty()

bool tesseract::CLIST::empty ( ) const

inline

Definition at line 89 of file clst.h.

                     { // is list empty?
    return !last;
  }

internal_deep_clear()

void tesseract::CLIST::internal_deep_clear

(

void(*)(void *)

zapper

)

Definition at line 36 of file clst.cpp.

                            {    // ptr to zapper functn
  if (!empty()) {
    auto ptr = last->next;     // set to first
    last->next = nullptr; // break circle
    last = nullptr;       // set list empty
    while (ptr) {
      auto next = ptr->next;
      zapper(ptr->data);
      delete (ptr);
      ptr = next;
    }
  }
}

length()

int32_t tesseract::CLIST::length ( ) const

inline

Definition at line 106 of file clst.h.

                         { //# elements in list
    int32_t count = 0;
    if (last != nullptr) {
      count = 1;
      for (auto it = last->next; it != last; it = it->next) {
        count++;
      }
    }
    return count;
  }

set_subtract()

void tesseract::CLIST::set_subtract	(	int	comparatorconst void *, const void *,
		bool	unique,
		CLIST *	minuend,
		CLIST *	subtrahend
	)

Definition at line 178 of file clst.cpp.

                                            {
  shallow_clear();
  CLIST_ITERATOR m_it(minuend);
  CLIST_ITERATOR s_it(subtrahend);
  // Since both lists are sorted, finding the subtras that are not
  // minus is a case of a parallel iteration.
  for (m_it.mark_cycle_pt(); !m_it.cycled_list(); m_it.forward()) {
    void *minu = m_it.data();
    void *subtra = nullptr;
    if (!s_it.empty()) {
      subtra = s_it.data();
      while (!s_it.at_last() && comparator(&subtra, &minu) < 0) {
        s_it.forward();
        subtra = s_it.data();
      }
    }
    if (subtra == nullptr || comparator(&subtra, &minu) != 0) {
      add_sorted(comparator, unique, minu);
    }
  }
}

shallow_clear()

void tesseract::CLIST::shallow_clear

(

)

Definition at line 60 of file clst.cpp.

                          { // destroy all links
  if (!empty()) {
    auto ptr = last->next;     // set to first
    last->next = nullptr; // break circle
    last = nullptr;       // set list empty
    while (ptr) {
      auto next = ptr->next;
      delete (ptr);
      ptr = next;
    }
  }
}

shallow_copy()

void tesseract::CLIST::shallow_copy ( CLIST *  from_list )

inline

Definition at line 97 of file clst.h.

                        { // beware destructors!!
    last = from_list->last;
  }

singleton()

bool tesseract::CLIST::singleton ( ) const

inline

Definition at line 93 of file clst.h.

                         {
    return last != nullptr ? (last == last->next) : false;
  }

sort()

void tesseract::CLIST::sort

(

int

comparator const void *, const void *

)

Definition at line 104 of file clst.cpp.

                                     {
  // Allocate an array of pointers, one per list element.
  auto count = length();
  if (count > 0) {
    // ptr array to sort
    std::vector<void *> base;
    base.reserve(count);
 
    CLIST_ITERATOR it(this);
 
    // Extract all elements, putting the pointers in the array.
    for (it.mark_cycle_pt(); !it.cycled_list(); it.forward()) {
      base.push_back(it.extract());
    }
 
    // Sort the pointer array.
    qsort(&base[0], count, sizeof(base[0]), comparator);
 
    // Rebuild the list from the sorted pointers.
    for (auto current : base) {
      it.add_to_end(current);
    }
  }
}

Friends And Related Function Documentation

CLIST_ITERATOR

friend class CLIST_ITERATOR

friend

Definition at line 65 of file clst.h.

---

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

• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/clst.h
• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/clst.cpp