ELIST2 Class Reference

#include <elst2.h>

Public Member Functions
	ELIST2 ()
void	internal_clear (void(*zapper)(ELIST2_LINK *))
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 82 of file elst2.h.

Constructor & Destructor Documentation

ELIST2()

ELIST2::ELIST2 ( )

inline

Definition at line 96 of file elst2.h.

        :
    ELIST2() {  //constructor
      last = nullptr;

Member Function Documentation

add_sorted()

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

Definition at line 139 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())

assign_to_sublist()

void 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, nullptr);

empty()

bool ELIST2::empty ( ) const

inline

Definition at line 104 of file elst2.h.

                       {  //is list empty?
      return !last;

internal_clear()

void ELIST2::internal_clear

(

void(*)(ELIST2_LINK *)

zapper

)

Definition at line 38 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 ELIST2::internal_deep_copy	(	ELIST2_LINK *(*)(ELIST2_LINK *)	copier,
		const ELIST2 *	list
	)

length()

int32_t ELIST2::length

(

)

const

Definition at line 85 of file elst2.cpp.

                             {  // count elements
  ELIST2_ITERATOR it(const_cast<ELIST2*>(this));
  int32_t count = 0;
 

shallow_copy()

void ELIST2::shallow_copy ( ELIST2 *  from_list )

inline

Definition at line 112 of file elst2.h.

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

singleton()

bool ELIST2::singleton ( ) const

inline

Definition at line 108 of file elst2.h.

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

sort()

void ELIST2::sort

(

int

comparator const void *, const void *

)

Definition at line 102 of file elst2.cpp.

                                                                               :
 *   (int (*)(const void *, const void *)
 **********************************************************************/
 
void
ELIST2::sort (                   //sort elements
int comparator (                 //comparison routine
const void *, const void *)) {
  ELIST2_ITERATOR it(this);
  int32_t count;
  ELIST2_LINK **base;            //ptr array to sort
  ELIST2_LINK **current;
  int32_t i;
 
  /* Allocate an array of pointers, one per list element */
  count = length ();
  base = static_cast<ELIST2_LINK **>(malloc (count * sizeof (ELIST2_LINK *)));
 
  /* Extract all elements, putting the pointers in the array */
  current = base;
  for (it.mark_cycle_pt (); !it.cycled_list (); it.forward ()) {
    *current = it.extract ();
    current++;
  }
 
  /* Sort the pointer array */
  qsort(base, count, sizeof(*base), comparator);
 
  /* Rebuild the list from the sorted pointers */
  current = base;
  for (i = 0; i < count; i++) {

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:

• /tesseract/src/ccutil/elst2.h
• /tesseract/src/ccutil/elst2.cpp