tesseract::ELIST2 Class Reference

#include <elst2.h>

Public Member Functions
void	internal_clear (void(*zapper)(void *))
bool	empty () const
bool	singleton () const
void	shallow_copy (ELIST2 *from_list)
void	internal_deep_copy (ELIST2_LINK *(*copier)(ELIST2_LINK *), const ELIST2 *list)
void	assign_to_sublist (ELIST2_ITERATOR *start_it, ELIST2_ITERATOR *end_it)
int32_t	length () const
void	sort (int comparator(const void *, const void *))
void	add_sorted (int comparator(const void *, const void *), ELIST2_LINK *new_link)

Friends
class	ELIST2_ITERATOR

Detailed Description

Definition at line 86 of file elst2.h.

Member Function Documentation

add_sorted()

void tesseract::ELIST2::add_sorted	(	int	comparatorconst void *, const void *,
		ELIST2_LINK *	new_link
	)

Definition at line 120 of file elst2.cpp.

                                                                                         {
  // Check for adding at the end.
  if (last == nullptr || comparator(&last, &new_link) < 0) {
    if (last == nullptr) {
      new_link->next = new_link;
      new_link->prev = new_link;
    } else {
      new_link->next = last->next;
      new_link->prev = last;
      last->next = new_link;
      new_link->next->prev = new_link;
    }
    last = new_link;
  } else {
    // Need to use an iterator.
    ELIST2_ITERATOR it(this);
    for (it.mark_cycle_pt(); !it.cycled_list(); it.forward()) {
      ELIST2_LINK *link = it.data();
      if (comparator(&link, &new_link) > 0) {
        break;
      }
    }
    if (it.cycled_list()) {
      it.add_to_end(new_link);
    } else {
      it.add_before_then_move(new_link);
    }
  }
}

assign_to_sublist()

void tesseract::ELIST2::assign_to_sublist	(	ELIST2_ITERATOR *	start_it,
		ELIST2_ITERATOR *	end_it
	)

Definition at line 68 of file elst2.cpp.

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

empty()

bool tesseract::ELIST2::empty ( ) const

inline

Definition at line 99 of file elst2.h.

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

internal_clear()

void tesseract::ELIST2::internal_clear

(

void(*)(void *)

zapper

)

Definition at line 37 of file elst2.cpp.

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

internal_deep_copy()

void tesseract::ELIST2::internal_deep_copy	(	ELIST2_LINK *(*)(ELIST2_LINK *)	copier,
		const ELIST2 *	list
	)

length()

int32_t tesseract::ELIST2::length ( ) const

inline

Definition at line 121 of file elst2.h.

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

shallow_copy()

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

inline

Definition at line 107 of file elst2.h.

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

singleton()

bool tesseract::ELIST2::singleton ( ) const

inline

Definition at line 103 of file elst2.h.

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

sort()

void tesseract::ELIST2::sort

(

int

comparator const void *, const void *

)

Definition at line 88 of file elst2.cpp.

                                     {
  // Allocate an array of pointers, one per list element.
  auto count = length();
  if (count > 0) {
    // ptr array to sort
    std::vector<ELIST2_LINK *> base;
    base.reserve(count);
 
    ELIST2_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

ELIST2_ITERATOR

friend class ELIST2_ITERATOR

friend

Definition at line 87 of file elst2.h.

---

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

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