Tree_V.h

Ir a la documentación de este archivo.

// Tree_V.h (c) 2004 adolfo@di-mare.com

/** \file Tree_V.h
    \brief Declaraciones y definiciones para la clase \c Tree

    \author Adolfo Di Mare <adolfo@di-mare.com>
    \date    2004

    - Why English names??? ==> http://www.di-mare.com/adolfo/binder/c01.htm#sc04
*/

#ifndef Tree_V_h
#define Tree_V_h

#ifndef NDEBUG // ==> Overview of File Translation ==> C++
    #define USE_v_Alive
    #undef  USE_v_Alive
#endif

#include <cassert> // para usar assert()

/// Arboles de adolfo@di-mare.com cuyos nodos contienen un vector de punteros a sus hijos
namespace TV {

template <class E> class Tree;
template <class E> bool check_ok( const E & );
template <class E> bool check_ok( const Tree<E>& T); // declaration hacia adelante

/// Nodos almacenados en el árbol.
template <class E>
class Tree_Node {
public:
    friend class Tree<E>;
    typedef E value_type; ///< Nombre estándar del tipo de elemento contenido
private:
    Tree_Node( const value_type& d ) : m_data( d ), m_refCount(1), m_n_child(0), m_father(0) {} ///< Constructor de vector
    static Tree_Node* Get_New(const E& d);
    void No_Children() { for (unsigned i=0; i < N; ++i) { m_Lchild[i]= 0; } } ///< Pone en nulo todos los punteros a los hijos porque ni \c Get_New() ni el constructor lo hacen
private:
    static const unsigned N = 15; ///< Cantidad máxima de hijos por nodo
    value_type  m_data; ///< Valor almacenado en el nodo
    unsigned    m_refCount; ///< Cantidad de punteros hacia mi
    int         m_n_child; ///< Soy el el hijo número \c "m_n_child" de mi padre
    Tree_Node * m_father; ///< Puntero al nodo padre
    Tree_Node * m_Lchild[N]; ///< Punteros a cada uno de los hijos
private:
    #ifdef USE_v_Alive // ==> NDEBUG ==> Overview of File Translation ==> C++
        static const unsigned N_Alive = 1033; ///< Cantidad máxima posible de punteros en uso
        static Tree_Node *    m_v_Alive[N_Alive]; ///< Punteros en uso
        static unsigned       m_n_Alive; ///< Cantidad de punteros en uso
    #endif
}; // Tree_Node

/** Los métodos para trabajar con árboles regresan "referencias" que son sub-árboles.
    - Un sub-árbol es parte del árbol, por lo que al modificar los valores del
      sub-árbol también el árbol original queda cambiado.
    - Para evitar este tipo de modificación indirecta, es necesario trabajar
      con una "copia profunda" del árbol orignal, la que se puede obtener con
      \c Tree<E>::Copy_Deep().
    - Aún si el árbol original es eliminado, el sub-árbol continúa existiendo
    - Debido a que los árboles y sub-árboles son referencias, en C++ es necesario mantener
      internamente "cuentas de referencia" que impiden que métodos como \c Father() o \c Root()
      sean métodos <code>const</code>.
    - Muchos métodos retornan referencias \c Tree& porque es más eficiente, pues cada
      vez que un \c Tree es copiado hay que actualizar la "cuenta de referencia" de
      la raíz del sub-árbol. */
template <class E>
class Tree {
public:
    typedef E value_type; ///< Nombre estándar del tipo de elemento contenido
private:
    static const unsigned N = Tree_Node<E>::N; ///< Cantidad máxima de hijos por nodo

/// \name Constructores y destructor
//@{
public:
    Tree() : m_root(0) {} ///< Constructor de vector
    Tree(const Tree& o);
    Tree(const value_type & d);
    ~Tree();
private:
    /// Constructor a partir de un nodo
    Tree(Tree_Node<E>* p) : m_root(p) { if (p!=0) { p->m_refCount++; } }
    /// Truco para usar el constructor que no verifica <code> (p != 0) </code>
    typedef void NOT_null_pointer;
    /// Constructor a partir de un nodo [ requiere <code> p != 0 </code> ]
    Tree(NOT_null_pointer* p) : m_root( (Tree_Node<E>*)p) { // assert( p != 0 );
        ((Tree_Node<E>*)p)->m_refCount++; }
//@}

/// \name Operaciones básicas
//@{
public:
    bool     Empty() const { return (m_root == 0); } ///< Retorna \c "true" si el sub-árbol está vacío
    unsigned Count() const ;
    unsigned Count_Children() const ;
    unsigned Size () const { return Count(); } ///< Usa \c Count() para retornar la cantidad de valores almacenados en el sub-árbol
    friend bool check_ok<E>(const Tree<E>& T);
    bool        Ok() { return check_ok(*this); } ///< Usa \c check_ok(Tree& T) para verificar la invariante de \c Tree
//@}

/// \name Operaciones de borrado
//@{
public:
    void Erase();
    void Erase_Son(unsigned n) { Tree T; Graft(n, T); }
//@}

/// \name Operaciones de copiado
//@{
public:
    Tree& operator= (const Tree &o) { return Copy(o); } ///< Sinónimo de \c this->Copy(o)
    Tree& Copy (const Tree &o);
    Tree& Move (Tree &o);
    Tree& Swap (Tree &o);
    Tree& Copy_Deep( const Tree &o );
    /// Usa \c Change_Root() para sustituir por "d" el valor almacenado en la raíz del árbol
    Tree& operator=( const value_type & d) { Change_Root(d); return *this; }
//@}

/// \name Métodos para cambiar los valores almacenados en el árbol
//@{
public:
    Tree Change_Root(const value_type &d);
    Tree Change_Child( unsigned n, const value_type &d );
    Tree Change_Left_Sibling_Inmediate( const value_type &d );
    Tree Change_Right_Sibling_Inmediate( const value_type &d );
    Tree Graft( unsigned n, Tree &o );
//@}

/// \name Operaciones para usar los valores almacenados
//@{
public:
    value_type& Data        () { return  m_root->m_data;  } ///< Valor almacenado en la raíz del sub-árbol
    value_type& operator *  () { return   Data();  } ///< Valor almacenado en la raíz del sub-árbol
    value_type* operator -> () { return &(m_root->m_data); } ///< Puntero al valor almacenado en la raíz del sub-árbol
    const value_type& Data        () const { return  m_root->m_data;  } ///< Valor almacenado en la raíz del sub-árbol
    const value_type& operator *  () const { return   Data();  } ///< Valor almacenado en la raíz del sub-árbol
    const value_type* operator -> () const { return &(m_root->m_data); } ///< Puntero al valor almacenado en la raíz del sub-árbol
//@}

/// \name Operaciones de comparación
//@{
public:
    template <class X> friend bool operator == (const Tree<X> &p, const Tree<X> &q); ///< ¿¿¿ (p == q) ???
    template <class X> friend bool operator != (const Tree<X> &p, const Tree<X> &q); ///< ¿¿¿ (p != q) ???
    bool Equals( const Tree & o ) const { return (*this)==o; } ///< ¿¿¿ (*this==o) ???
    /// Retorna \c true si \c "o" comparte la raíz con \c "*this"
    bool Same( const Tree & o ) const { return m_root == o.m_root; }
//@}

/// \name Métodos para recorrer el árbol
//@{
public:
    Tree Root() const { return Tree( m_root ); } ///< Raíz del sub-árbol
    Tree Father() const ;
    Tree Child(unsigned n) const;
    Tree Left() const;
    Tree Right() const;
    Tree Leftmost() const;
    Tree Rightmost() const;
    Tree Sibling(int n) const;
    Tree Left_Sibling() const;
    Tree Right_Sibling() const;
    Tree Previous_Sibling() const { return Left_Sibling(); } ///<  Sinónimo de \c Left_Sibling()
    Tree Prev_Sibling() const { return Left_Sibling(); } ///<  Sinónimo de \c Left_Sibling()
    Tree Next_Sibling() const { return Right_Sibling(); } ///<  Sinónimo de \c Right_Sibling()
    Tree Right_Sibling_Inmediate() const;
    Tree Left_Sibling_Inmediate() const;
//@}

/// \name Propiedades del árbol
//@{
public:
    /// Retorna \c "n" si \c "*this" es el n-ésimo hijo de su padre, si no retorna \c 0 (cero)
    unsigned Child_Number() const { return ( m_root==0 ? 0 : m_root->m_n_child ); }
    /// Retorna \c "n" si el hijo más izquierdo de \c "*this" es el n-ésimo hijo, si no retorna \c 0 (cero)
    unsigned Leftmost_N() const { return Leftmost().Child_Number(); }
    /// Retorna \c "n" si el hijo más derecho de \c "*this" es el n-ésimo hijo, si no retorna \c 0 (cero)
    unsigned Rightmost_N() const { return Rightmost().Child_Number(); }
    /// Retorna \c "true" si el árbol es una hoja
    bool Is_Leaf() const { return ( ! Empty() && Leftmost().Empty() ); }
    /// Retorna \c "true" si el árbol no tiene padre
    bool Is_Root() const { return ( m_root != 0  && m_root->m_father == 0 ); }
    /// Cantidad de referencias de la raíz del árbol
    unsigned use_count() const { return (m_root==0 ? 0 : m_root->m_refCount); }
//@}

/// \name Funciones para manipular valores a bajo nivel
//@{
private:
    /// Convierte el puntero al nodo en un referencia a \c Tree
    static Tree& CastTo_Tree_Ref ( Tree_Node<E> * &p )
    { return (Tree&) *( reinterpret_cast<Tree*> (&p)); }
//@}

/// \name Funciones recursivas que realizan el trabajo sobre nodos
//@{
private:
    static void Erase0(Tree_Node<E> * p);
    static bool Comp0(const Tree_Node<E> *p, const Tree_Node<E> *q);
    static void Count0(const Tree_Node<E> * p, unsigned & n);
    static Tree_Node<E>* Copy_Deep0(Tree_Node<E> * father, const Tree_Node<E> * p);
//@}
private:
    Tree_Node<E> * m_root; ///< Un árbol "es" el puntero al nodo raíz
}; // Tree

#ifdef USE_v_Alive
    unsigned Tree<E>::Tree_Node<E>::m_n_Alive = 0; // Hay que "repetir" estos nombres acá para que el ...
    Tree_Node<E>* Tree<E>::Tree_Node<E>::m_v_Alive[Tree<E>::Tree_Node<E>::N_Alive]; // ... compilador les asigne memoria
#endif

/** Crea un nuevo nodo y lo inicializa con \c "d".
    - Para mejorar la eficiencia, no incializa los punteros a los hijos.
    - Si la macro \c USE_v_Alive de compilación existe, también agrega el nuevo
      nodo al contenedor global \c Tree<E>::m_v_Alive[], de manera que es posible
      saber si un puntero a un nodo está o no en uso.
    - En realidad sobra usar este método, pero la utilidad de usarlo es
      que es posible examinar \c Tree<E>::m_v_Alive[] para saber si los métodos
      de árbol están correctamente implementados. */
template <class E>
inline Tree_Node<E> * Tree_Node<E>::Get_New( const E& d) {
    Tree_Node<E>* p = new Tree_Node(d);
    #ifdef USE_v_Alive
        m_v_Alive[m_n_Alive] = p;
        m_n_Alive++;
    #endif
    return p;
}

/**  Constructor de copia desde otro árbol (copia superficial).
    - Como un sub-árbol en realidad es una referencia, este método
      no hace la copia completa [profunda] del árbol. */
template <class E>
inline Tree<E>::Tree(const Tree& o) {
    if (o.m_root != 0) {
        o.m_root->m_refCount++; // una referencia más porque "o" y "*this" ...
    }
    m_root =  o.m_root; // ... ahora comparten la raíz
}

/**  Destructor.
    \par Complejidad:
         O( \c Count() )

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc04 */
template <class E>
inline Tree<E>::~Tree() {
    if (m_root != 0) { Erase0(m_root); }
}

/// Constructor a partir de un valor.
template <class E>
inline Tree<E>::Tree(const E& d) {
    m_root = Tree_Node<E>::Get_New(d);
    m_root->No_Children(); // ... pues el constructor no inicializa los punteros a los hijos
}

/** Copia superficial desde \c "o".
    - El valor anterior de \c "*this" se pierde.

    \par Complejidad:
         O( \c Count() )

    \returns *this

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc05 */
template <class E>
Tree<E>& Tree<E>::Copy( const Tree &o ) {
    if (m_root != o.m_root) { // evita auto-borrado
        if (m_root != 0) {
            Erase0(m_root); // borra el valor actual
        }
        m_root =  o.m_root; // comparte la raíz
        if (o.m_root != 0) {
            o.m_root->m_refCount++; // una referencia más
        }
    }
    return *this;
}

/** Traslada el valor de \c "o" a \c "*this".
  - El valor anterior de \c "*this" se pierde
  - El nuevo valor de \c "*this" es el que \c "o" tuvo
  - \c "o" queda en el estado en que lo dejaría \c Erase()
  - Si \c "*this" es \c "o" entonces su valor no cambia
  - En general, después de esta operación casi
    nunca ocurre que <code> (*this == o) </code>

    \par Complejidad:
         O( \c Count() )

    \returns \c *this

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc07 */
template <class E>
Tree<E>& Tree<E>::Move( Tree &o ) {
    if (m_root == o.m_root) { // evita auto-borrado
        if (m_root != 0) {
            Erase0(m_root); // borra el valor actual
        }
        m_root = o.m_root; // se roba los hijos
        o.m_root = 0; // anula al dador
    }
    return *this;
}

/** Intercambia los valores de \c "*this" y \c "o".
    - Debido a que algunos métodos retornan copias del valor de \c "*this" en
      lugar de una referencia, como ocurre con \c Tree<E>::Child(), a veces
      \c Swap() no tiene el resultado esperado por el programador.
    - Por ejemplo, si se invoca <code> T.Child(i). Swap( T.Child(j) ) </code>
      el resultado no es intercambiar los hijos, sino más bien intercambiar
      los valores de los sub-árboles temporales \c T.Child(i) y \c T.Child(j).
      La forma correcta de intercambiar hijos es usar \c Graft().

      \par Complejidad:
         O( \c 1 )

    \returns *this

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc08 */
template <class E>
inline Tree<E>& Tree<E>::Swap( Tree &o ) {
    Tree_Node<E> * tmp = m_root;
    m_root = o.m_root;
    o.m_root = tmp;
    return *this;
}

/** Acceso al padre.
    - Si el sub-árbol no tiene padre retorna el árbol vacío.

    \par Complejidad:
         O( \c 1 ) */
template <class E>
inline Tree<E> Tree<E>::Father() const {
    if (m_root == 0) {
        return Tree( );
    } else {
        return Tree( m_root->m_father );
    }
}

/** Acceso al \c "n"-ésimo hijo.
    - Si el sub-árbol no tiene un hijo número \c "n" retorna el sub-árbol vacío.

    \par Complejidad:
         O( \c 1 ) */
template <class E>
Tree<E> Tree<E>::Child( unsigned n ) const {
    if (n >= Tree<E>::N) {
        return Tree( );
    }
    if (m_root == 0) { // ignora árboles vacíos
        return Tree( );
    }
    return Tree ( m_root->m_Lchild[n] );
}

/** Sub-árbol izquierdo [en un árbol binario].
    - Sinónimo de \c Child(0).
    \par Complejidad:
         O( \c 1 ) */
template <class E>
inline Tree<E> Tree<E>::Left() const {
    if (m_root == 0) {
        return Tree( );
    } else {
        return Tree( m_root->m_Lchild[0] );
    }
}

/** Sub-árbol derecho [en un árbol binario].
    - Sinónimo de \c Child(1).

    \par Complejidad:
         O( \c 1 ) */
template <class E>
inline Tree<E> Tree<E>::Right() const {
    if (m_root == 0) {
        return Tree( );
    } else {
        return Tree( m_root->m_Lchild[1] );
    }
}

/** \typedef Tree<E>::NOT_null_pointer
    \brief Truco para evitar comparar con \c 0 ( \c nil )
    al usar \c Tree_Node<E>* para construir \c Tree().

    Al implementar cada uno de los métodos de \c Tree con frecuencia ocurre
    que es posible saber que el sub-árbol retornado no está vacío. En estos casos, conviene
    usar un contructor que no verifique si la raíz del árbol es nula.

    Esta clase se usa como una marca para que se ejecute el contructor
    <code> Tree<E>::Tree(NOT_null_pointer* p) </code>
    que no verifica la nulidad de \c "m_root"; esta es una micro-eficiencia, pero aquí sirve
    para mostrar un truco que es muy usado en C++ para aumentar la eficiencia de los
    programas, pues le permite al programado usar la sobrecarga de operadores para evitar
    repetir verificaciones innecesarias.

    \see http://www.di-mare.com/adolfo/binder/c01.htm#k1-micro-eficiencia
*/

/** Obtiene el hermano no vacío anterior, que está hacia la izquierda.
    - Si no existe un hermano no vacío hacia la izquierda, retorna un sub-árbol vacío.
    - Si <code>n == Child_Number()</code> no necesariamente ocurrirá que
      <code> (n-1)== Left_Sibling().Child_Number()</code>
      pues los anteriores hijos de \c Father() pueden ser sub-árboles vacíos, como ocurre si
      un árbol binario tiene hijo derecho pero no tiene hijo izquierdo.
    - Este método usualmente se usa junto con \c Rightmost()

    \par Complejidad:
         O( <code> Father().Count_Children() </code> ) */
template <class E>
Tree<E> Tree<E>::Left_Sibling() const {
    if (m_root == 0)  {
        return Tree( );
    }
    if (m_root->m_father == 0)  {
        return Tree( );
    }

    unsigned i = m_root->m_n_child;
    for (;;) {
        if (i == 0) { // tanto enredo para usar "unsigned" en lugar de "int"
            break;
        }
        --i;
        if (m_root->m_father->m_Lchild[i] != 0) {
            return Tree( (NOT_null_pointer*) m_root->m_father->m_Lchild[i] );
        }
    }
    return Tree( ); // ya no hay más hermanos
}

/** Obtiene el hermano no vacío siguiente, que está hacia la derecha.
    - Si no existe un hermano hacia la derecha, retorna un sub-árbol vacío.
    - Si <code>n == Child_Number()</code> no necesariamente ocurrirá que
      <code>(n+1) == Right_Sibling().Child_Number()</code>
      pues los siguientes hijos de \c Father() pueden ser sub-árboles vacíos, como ocurre si
      un árbol binario tiene hijo izquierdo pero no tiene hijo derecho.
    - Este método usualmente se usa junto con \c Leftmost()

    \par Complejidad:
         O( <code> Father().Count_Children() </code> ) */
template <class E>
Tree<E> Tree<E>::Right_Sibling() const {
    if (m_root == 0)  {
        return Tree( );
    }
    if (m_root->m_father == 0) {
        return Tree( );
    }
    for (unsigned i = m_root->m_n_child + 1; i<N; ++i) { // comienza en el hermano derecho
        if ( m_root->m_father->m_Lchild[i] != 0) {
            return Tree ( (NOT_null_pointer*) m_root->m_father->m_Lchild[i] );
        }
    }
    return Tree( ); // ya no hay más hermanos
}

/** Obtiene el hermano que está inmediatamente hacia la izquierda.
    - Este método es equivalente a invocar \c Sibling( -1 )
    - Si no existe un hermano hacia la derecha, retorna un sub-árbol vacío.

    \par Complejidad:
         O( \c 1 ) */
template <class E>
Tree<E> Tree<E>::Left_Sibling_Inmediate() const {
    if (m_root == 0)  {
        return Tree( );
    }
    if (m_root->m_father == 0)  {
        return Tree( );
    }
    unsigned nplus = 1 + m_root->m_n_child;
    if ( m_root->m_n_child == 0 ) {
        return Tree( );
    } else {
        return Tree ( m_root->m_father->m_Lchild[ m_root->m_n_child - 1 ] );
    }
}

/** Obtiene el hermano que está inmediatamente hacia la derecha.
    - Este método es equivalente a invocar \c Sibling( +1 )
    - Si no existe ese hermano hacia la derecha, retorna un sub-árbol vacío.

    \par Complejidad:
         O( \c 1 ) */
template <class E>
Tree<E> Tree<E>::Right_Sibling_Inmediate() const {
    if (m_root == 0)  {
        return Tree( );
    }
    if (m_root->m_father == 0)  {
        return Tree( );
    }
    unsigned nplus = 1 + m_root->m_n_child;
    if ( nplus == N ) {
        return Tree( );
    } else {
        return Tree ( m_root->m_father->m_Lchild[nplus] );
    }
}

/** \c "n"-ésimo hermano a partir de \c "*this".
    - El hermano puede ser vacío aunque haya otros hermanos que no son vacíos.
    - Se "corre" hacia el n-ésimo hermano \c "n" "posiciones".
    - El hermano se determina contando sub-árboles hacia la derecha o izquierda de acuerdo
      al signo de \c "n":
          - Si \c n=0, regresa \c "*this".
          - Si \c n>0, regresa el hermano número \c "+n" contando hacia la derecha de \c "*this".
          - Si \c n<0, regresa el hermano número \c "-n" contando hacia la izquierda de \c "*this".
    - Si no existe un hermano número \c "n" retorna un sub-árbol vacío.
    - El árbol \c "T" tiene 3 hijos no vacíos \c "B", \c "C" y \c "E" y tiene 4 sub-árboles:
            - <code> C.Sibling( +0 ) == C</code>
            - <code> B.Sibling( +1 ) == C</code>
            - <code> E.Sibling( -2 ) == C</code>
            - <code> E.Sibling( -1 ) --> Vacío</code>
            - <code> A.Sibling( +1 ) --> Vacío </code>
            - <code> B.Sibling( -1 ) --> Vacío </code>
            - <code> E.Sibling( +1 ) --> Vacío </code>
        \code
           A <-- T
          /|\
        / / \ \       [] --> es representa un sub-árbol vacío
       B C  [] E
        \endcode

    \par Complejidad:
         O( <code> Father().Count_Children() </code> ) */
template <class E>
Tree<E> Tree<E>::Sibling( int n ) const {
    if (m_root == 0)  {
        return Tree( );
    }
    if ( n==0 ) {
        return Tree( (NOT_null_pointer*) m_root );
    }
    if (m_root->m_father == 0)  {
        return Tree( );
    }

    if ( n >= 0 ) {
        unsigned n_new = n + m_root->m_n_child;
        if (n_new < Tree<E>::N) {
            return Tree( m_root->m_father->m_Lchild[n_new] );
        } else {
            return Tree( );
        }
    } else {
        int n_abs = -n;
        if ( m_root->m_n_child >= n_abs ) { // se puede hacer la resta
            return Tree( m_root->m_father->m_Lchild[ m_root->m_n_child - n_abs ] );
        } else {
            return Tree( );
        }
    }
}

/** Obtiene el hijo más izquierdo del árbol.
    - Este método usualmente se usa junto con \c Right_Sibling()

    \par Complejidad:
         O( <code> Count_Children() </code> )

    \remark Esta es una forma de procesar los hijos no vacíos de un sub-árbol de izquierda a derecha:

    \code
    Tree<E> Child = T.Leftmost();
    while ( ! Child.Empty() ) {
        Process( Child );
        Child = Child.Right_Sibling();
    }
    \endcode */
template <class E>
Tree<E> Tree<E>::Leftmost() const {
    if (m_root == 0)  {
        return Tree( );
    }
    for (unsigned i=0; i<N; ++i) {
        if ( m_root->m_Lchild[i] != 0) {
            return Tree ( (NOT_null_pointer*) m_root->m_Lchild[i] );
        }
    }
    return Tree( ); // ==> m_root == 0
}

/** Obtiene el hijo más derecho del árbol.
    - Este método usualmente se usa junto con \c Left_Sibling()
    - Requiere O(n) tiempo de ejecución, donde \c "n" es la cantidad de hijos de \c "*this"

   \remark Esta es una forma de procesar los hijos no vacíos de un sub-árbol de derecha a izquierda:

   \code
    Tree<E> Child = T.Rightmost();
    while ( ! Child.Empty() ) {
        Process( Child );
        Child = Child.Left_Sibling();
    }
   \endcode */
template <class E>
Tree<E> Tree<E>::Rightmost() const {
    if (m_root == 0)  {
        return Tree( );
    }

    unsigned i = N;
    for (;;) {
        if (i == 0) { // tanto enredo ... para usar "unsigned" en lugar de "int"
            break;
        }
        --i;
        if (m_root->m_Lchild[i] != 0) {
            return Tree( (NOT_null_pointer*) m_root->m_Lchild[i] );
        }
    }
    return Tree( ); // ==> m_root == 0
}

/** Implementación recursiva para \c Count().
    - Incrementa \c "n" en el número de hijos que tiene el sub-árbol cuya raíz es \c "p"
    - Cambia el valor de \c "n"
    - No cuenta el nodo raíz \c "p"
    - Esta función complementa a \c Count()

    \pre p != 0 */
template <class E>
void Tree<E>::Count0(const Tree_Node<E> * p, unsigned & n) {
    for (unsigned i=0; i < N; ++i) {
        if (p->m_Lchild[i] != 0) {
            ++n; // cuenta a este hijo
            Count0( p->m_Lchild[i], n );
        }
    }
}

/** Retorna la cantidad de valores almacenados en el sub-árbol.
    - Calcula el número de sub-árboles no vacíos del árbol

    \par Complejidad:
         O( \c Count() ) ==> tiempo <br>
         O( \c Height() ) ==> espacio

    \see http://www.di-mare.com/adolfo/binder/c05.htm#sc03 */
template <class E>
unsigned Tree<E>::Count() const {
    if (m_root == 0) {
        return 0;
    } else {
        unsigned n = 1; // comienza contando en uno...
        Count0(m_root, n); // ... porque Count0() no cuenta la raíz
        return n;
    }
}

/** Retorna la cantidad de hijos del árbol.
    \par Complejidad:
         O( \c Count_Children() ) */
template <class E>
unsigned Tree<E>::Count_Children() const {
    unsigned tot = 0;
    for (unsigned i=0; i < N; ++i) {
        if (m_root->m_Lchild[i] != 0) {
            ++tot; // cuenta a este hijo porque no está vacío
        }
    }
    return tot;
}
template <class E>
inline bool operator == (const Tree<E> &p, const Tree<E> &q) { return Tree<E>::Comp0(p.m_root, q.m_root); }
template <class E>
inline bool operator != (const Tree<E> &p, const Tree<E> &q) { return !(p == q); }

/** Compara recursivamente los árboles cuyos nodo raíz son \c "*p" y \c "*q".
    - Implementación recursiva para <code> operator==(Tree, Tree) </code> */
template <class E>
bool Tree<E>::Comp0(const Tree_Node<E> *p, const Tree_Node<E> *q) {
    if (p == q) {
        return true;
    }
    if ( (p==0) || (q == 0)) { // son diferentes...
        return false; // ...pues sólo 1 está vácio
    }
    if ( ! (p->m_data == q->m_data) ) {
        return false; // valor diferente en la raíz
    }

    // A comparar a todos los hijos
    for (unsigned i=0; i < Tree<E>::N; ++i) {
        if (! Comp0(p->m_Lchild[i], q->m_Lchild[i]) ) {
            return false;
        }
    }

    return true; // pues nunca encontró nodos diferentes
}

/**   Verifica que se cumpla la invariante de la clase, o sea, que el objeto esté bien construido.
      - La razón por la que esta función no es un método es continuar la costumbre de muchos
        programadores quienes no definen la invariante para sus clases, pues en muchos
        casos sobra hacerlo.
      - No invoca \c check_ok( value_type& ) para cada valor almacenado, aunque si el árbol
        cumple con su invariante necesariamentes es porque también sus elementos almacenados
        están bien construidos.
      - Esta función en general es difícil de implementar, y en algunos casos es imposible
        pues, cuando el objeto no está bien construido, puede ocurrir que la función no
        retorne (como ocurriria si un nodo interno del árbol apunta de vuelta a la raíz, lo
        que se resulta en un círculo).
      - En general, la implementáción de esta función no es completa pues hay casos en que
        es imposible verificar la invariante de una clase.

    \par Complejidad:
         O( \c Count() ) ==> tiempo <br>
         O( \c Height() ) ==> espacio

         \post Retorna \c "true" si el árbol es un objeto bien construido
      \see \c check_ok(Tree&)

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc11 */
template <class E>
bool check_ok(const Tree<E>& T) {

    if ( T.Empty() ) {
        return true;
    }

    #ifdef NO_Implementado_para_evitar_forzar_que_el_valor_almacenado_tenga_su_metodo_OK
        if (! check_ok( T.Data() ) ) { // si el valor almacenado no esta bien...
            return false; //... tampoco lo está el árbol
        }
        /* Usar la función check_ok(Tree<E>::value_type en lugar del método
        Tree<E>::value_type::Ok() evitar forzar a que los programadores clientes
        que usen árboles estén obligados a implementar el método
        Tree<E>::value_type::Ok(), que se encarga de verificar la invariante del valor
        almacenado en le árbol.
        - Lindo: if (! check_ok( T.Data() ) ) //.... la función check_ok() es opcional
        - ¡FEO!: if (! T.Data().Ok() ) //... pues obliga a que exista el método value_type::Ok()
        */
    #endif

    for (unsigned i = 0; i < Tree<E>::N; ++i) {
        if ( T.Child(i).Empty() ) { // este hijo no existe
            // continue; // con el siguiente
        }
        else if ( T.Child(i).Father() != T.Root() ) { // ==> ! T.Father.Empty()
            return false; // parece que este hijo no es mi hijo...
        }
        else if ( i != T.Child(i).Child_Number() ) {
            return false; // no estoy registrado como el i-ésimo hijo de mi padre
        }
        else if ( T.Child(i).Father().Child( i ) != T.Child( i ) ) {
            return false; // no estoy registrado como el i-ésimo hijo de mi padre
        }
        else if ( ! check_ok( T.Child(i) ) ) {
            return false; // hijo roto...
        }
    }
    return true;

    // Las siguientes relaciones lógicas se cumplen
    // [ ! T.Empty() ]                    ==> [ T.Root()!= Tree() ]
    // [ T.Child(i).Father() == T.Root()] ==> [ ! T.Father.Empty() ]

    /* Si este método retorna es porque el árbol está bien construido. Sin embargo,
       una invocación a check_ok() con un árbol mal construido posiblemente nunca retorne.
    */
}

/**  Sustituye por \c "d" el valor almacenado en la raíz del árbol.
    - Si el árbol está vacío, le agrega el nodo raíz.

    \returns \c *this */
template <class E>
Tree<E> Tree<E>::Change_Root(const value_type & d) {
    if (m_root == 0) { // como el árbol está vacío hay que agregarle la raíz
        m_root = Tree_Node<E>::Get_New(d); // crea el nodo raíz
        m_root->No_Children(); // y le pone en blanco todos sus hijos
    } else { // como no hay más referencias....
        m_root->m_data = d; // ... cambia el valor directamente
    }
    return *this;
}

/** Sustituye por \c "d" el valor almacenado en el hijo número \c "n" del árbol.
    - Si no existe el hijo número \c "n", lo agrega como una hoja con valor \c "d"
    - Si ya existe el hijo número \c "n", le sustituye su valor por \c "d"

    \pre <code> !Empty() && (0 <= n) && (n < Tree<E>::N) </code>

    \par Complejidad:
         O( \c Count_Children() )

    \returns <code> Child(n) </code> */
template <class E>
Tree<E> Tree<E>::Change_Child(unsigned n, const value_type &d) {
    if (m_root == 0) { // ignora árboles vacíos
        return Tree( );
    }
    if (n >= Tree<E>::N) { // ignora índices fuera de rango
        return Tree( );
    }
    if (m_root->m_Lchild[n] == 0) { // Hay que agregar un sub-árbol nuevo
        Tree_Node<E> * p = Tree_Node<E>::Get_New(d);
        p->No_Children();
        p->m_father = m_root;
        p->m_n_child = n;
        m_root->m_Lchild[n] = p;
    } else {
        m_root->m_Lchild[n]->m_data = d; // cambia el valor directamente
    }
    return Tree( (NOT_null_pointer*) m_root->m_Lchild[n] );
}

/** Sustituye por \c "d" el valor almacenado en el hermano inmediatamente anterior del sub-árbol.
    - Si <code> n == Child_Number() </code> cambia el valor
      del hijo número \c "n-1" de \c Father()
    - Si no existe el hijo número \c "n-1" de \c Father() lo agrega como
      una hoja con valor \c "d"
    - Si ya existe ese hijo número \c "n-1", le sustituye su valor por \c "d"
    - Retorna un árbol vacío si no es posible que exista el hijo número \c "n-1" de \c Father()

    \pre <code> !Empty() && (1 <= Child_Number()) </code>

    \par Complejidad:
         O( \c 1 )

    \returns El hermano izquierdo, <code> Sibling(-1) </code> */
template <class E>
Tree<E> Tree<E>::Change_Left_Sibling_Inmediate( const value_type &d ) {
    if (m_root == 0) { // ignora árboles vacíos
        return Tree( );
    }
    unsigned n = m_root->m_n_child;
    if ( n == 0 ) { // no hay hijos hacia la izquierda
        return Tree( );
    }
    // assert( (m_root->m_n_child > 0) && (n > 0) );
    n--;
    if (m_root->m_father->m_Lchild[ n ] == 0) { // Hay que agregar un sub-árbol nuevo
        Tree_Node<E> * p = Tree_Node<E>::Get_New(d);
        p->No_Children();
        p->m_father = m_root->m_father;
        p->m_n_child = n;
        m_root->m_father->m_Lchild[ n ]->m_data = d;
    } else {
        m_root->m_father->m_Lchild[ n ]->m_data = d; // cambia el valor directamente
    }
    return Tree( (NOT_null_pointer*) m_root->m_Lchild[n] );
}

/** Sustituye por \c "d" el valor almacenado en el hermano inmediatamente posterior del sub-árbol.
    - Si <code> n == Child_Number() </code> cambia el valor
      del hijo número \c "n+1" de \c Father()
    - Si no existe el hijo número \c "n+1" de \c Father() lo agrega como
      una hoja con valor \c "d"
    - Si ya existe ese hijo número \c "n+1", le sustituye su valor por \c "d"
    - Retorna un árbol vacío si no es posible que exista el hijo número \c "n+1" de \c Father()

    \pre <code> !Empty() && ( Child_Number() < Tree<E>::N ) </code>

    \par Complejidad:
         O( \c 1 )

    \returns El hermano derecho, <code> Sibling(+1) </code> */
template <class E>
Tree<E> Tree<E>::Change_Right_Sibling_Inmediate( const value_type &d ) {
    if (m_root == 0) { // ignora árboles vacíos
        return Tree( );
    }
    unsigned n = m_root->m_n_child + 1;
    if (n >= Tree<E>::N) { // no hay hijos hacia la derecha
        return Tree( );
    }
    // assert( n < Tree<E>::N );
    if (m_root->m_father->m_Lchild[ n ] == 0) { // Hay que agregar un sub-árbol nuevo
        Tree_Node<E> * p = Tree_Node<E>::Get_New(d);
        p->No_Children();
        p->m_father = m_root->m_father;
        p->m_n_child = n;
        m_root->m_father->m_Lchild[ n ]->m_data = d;
    } else {
        m_root->m_father->m_Lchild[ n ]->m_data = d; // cambia el valor directamente
    }
    return Tree ( m_root->m_Lchild[n] );
}

/** Elimina recursivamente a \c "*p" y a todos sus descendientes.
    - Implementación recursiva para \c Erase()
    - Borra el nodo sólo después de que constata que ya no hay punteros que le apunten
    - No actualiza los punteros en el padre ==> ese es el trabajo de \c Graft() o \c Erase()
    - Lo que sí hace es decrementar \c "p->m_refCount"
    - Recursivamente, borra a los descendientes de \c "*p"

    \pre <code> p != 0 </code>
    \post No cambia \c "p" porque trabaja con una copia de su valor */
template <class E>
void Tree<E>::Erase0( Tree_Node<E> * p ) {
    // assert( p != 0 );
    p->m_refCount--; // ya "p" no apunta al nodo
    if (p->m_refCount == 0) { // elimina el nodo ==> esta es la última referencia
        // A matar hijos...
        for (unsigned i = 0; i < N; i++) {
            Tree_Node<E> * q = p->m_Lchild[i];
            if (q != 0) {
                if (q->m_father == p) { // lo des-padre-ja...
                    q->m_father = 0; // ... pues ya "p" no es su padre
                }
                Erase0(q); // elimina recursivamente a cada uno de sus hijos
            }
            // Esta sobra porque "*p" va a desaparecer
            // p->m_Lchild[i] = 0; // ya ese nodo no es hijo de nadie
        }
        #ifdef USE_v_Alive
            // Elimina a "p" de m_v_Alive[]
            for (unsigned j = 0; j < Tree_Node<E>::N_Alive; ++j) {
                if (p == Tree_Node<E>::m_v_Alive[j]) { // busca hasta que encuentra al puntero
                    break;
                }
            }
            if (j < Tree_Node<E>::N_Alive) { // sí lo encontró
                for (unsigned k = j; k < Tree_Node<E>::N_Alive; ++k) { // corre a los demás para atrás
                    Tree_Node<E>::m_v_Alive[k] = Tree_Node<E>::m_v_Alive[k+1];
                }
                Tree_Node<E>::m_n_Alive--; // ahora hay uno menos
            } else {
                for (unsigned k = 0; k<3; ++j) { // marca "feos" los del final
                    Tree_Node<E>::m_v_Alive[Tree_Node<E>::N_Alive-1-k] = (Tree_Node<E> *)(-1);
                }
            }
        #endif
        delete p; // ... lo mata sólo si esta es la última referencia
    }
}

/** Elimina el árbol y sus descendientes.
    \par Complejidad:
         O( \c Count() ) + O( <code> Father().Count() </code> ) ==> tiempo <br>
         O( \c Height() ) ==> espacio

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc03 */
template <class E>
void Tree<E>::Erase() {
    if (m_root == 0) {
        return;
    } else if (m_root->m_father != 0) {
        m_root->m_father->m_Lchild[m_root->m_n_child] = 0;
    }
    Erase0(m_root);
    m_root = 0;
}

// Esta documentación para Tree<E>::Erase_Son() aparece acá porque Doxygen no permite
// incluir un párrafo aparte "\par" en la documentación de 1 sólo renglón.

/** \fn void Tree<E>::Erase_Son(unsigned n)

    \brief Elimina el sub-árbol número \c "n"

    \par Complejidad:
         O( <code> Child(n).Count() </code> ) ==> tiempo <br>
         O( <code> Height( Child(n) )  </code> ) ==> espacio
*/

/**   Verifica que se cumpla la invariante de la clase, o sea, que el objeto esté bien construido.
      - Además de todo el trabajo que hace \c check_ok(Tree& T), acá hay que constatar que
        el nodo raíz no tiene padre, que es la diferencia fundamental entre un árbol y un sub-árbol

      \post Retorna \c "true" si el árbol es un objeto bien construido

      \deprecated Los árboles y los sub-árboles son la misma cosa.

      \see \c check_ok(Tree&) */
template <class E>
inline bool check_ok_Tree(const Tree<E>& T) {
    if ( T.Root().Empty() ) {
        return true;
    } else {
        return ( T.Root().Father().Empty() ) && check_ok( Tree<E>(T) );
    }
}

/** Hace una copia profunda nodo por nodo del árbol cuyo nodo raíz es \c "*p".
    - Implementación recursiva para \c Tree<E>::Copy_Deep()
    - No altera \c p->m_refCount porque copia los nodos.
    - \c "father" indica quién debe ser el padre del nuevo nodo
    - \c "father" no es el padre de \c "*p"

    \pre <code> p != 0 </code>
    \post No cambia \c "p" porque trabaja con una copia de su valor

    \returns Puntero al nodo raíz del árbol copiado */
template <class E>
Tree_Node<E> * Tree<E>::Copy_Deep0(Tree_Node<E> * father, const Tree_Node<E> * p) {
    Tree_Node<E> * q; // resultado
    q = Tree_Node<E>::Get_New(p->m_data); // m_refCount = 1; m_n_child = 0; m_father = 0;
    q->m_n_child = p->m_n_child;
    q->m_father = father;

    // inicializa los punteros a los hijos que estarán en m_Lchild[]
    for (unsigned i=0; i < N; ++i) {
        if (p->m_Lchild[i] == 0) { // si en el árbol fuente este hijo no existe...
            q->m_Lchild[i]  = 0; // ...tampoco existirá en la copia
        } else { // copie todo el sub-árbol
            q->m_Lchild[i] = Copy_Deep0(q, p->m_Lchild[i]);
        }
    }
    return q;
}

/** Copia profunda de \c "o".
    - Copia todo el valor de \c "o" sobre \c "*this", de forma que el nuevo valor de
      \c "*this" sea un duplicado exacto del valor de \c "o"
    - El valor anterior de \c "*this" se pierde
    - El objeto \c "o" mantiene su valor anterior
    - Luego de la copia, cuando el valor de \c "o" cambia, el de \c "*this" no cambiará,
      y viceversa, pues la copia es una copia profunda; no es superficial
    - Si \c "*this" es \c "o" entonces su valor no cambia
    - Después de esta operación siempre ocurre que <code> *this == o </code>

    \par Complejidad:
         O( \c Count() ) + O( \c o.Count() )

  \returns \c *this

    \see http://www.di-mare.com/adolfo/binder/c04.htm#sc05 */
template <class E>
Tree<E>& Tree<E>::Copy_Deep(const Tree &o) {
    if (m_root != 0) {
        Erase0(m_root);  // Borra el contenido actual del árbol
    }
    if (o.m_root != 0 ) {
        m_root = Copy_Deep0(0, o.m_root); // 0 == cero == this->Father()
    } else {
        m_root = 0;
    }
    return *this;
}

/** Injerta \c "o" para que sea el \c "n"-ésimo hijo de \c "*this".
    - Si \c "o" es sub-árbol de otro árbol, dejara de serlo para pasar ser hijo de \c "*this"
    - Si \c "*this" tiene un \c "n"-ésimo hijo, ese hijo desaparece
    - Si \c "o" está vacío, elimina el \c "n"-ésimo hijo del árbol [<code> Erase_Son(n) </code>]

    \pre
    - <code> ! Root().Empty() </code>
       - Si el  árbol está vacío no tiene raíz, y por lo tanto tampoco puede tener hijos
    - <code> ! Ancestor(o, *this) </code>
       - "o" no puede ser ancestro de *this"
    - <code> (0 <= n) && (n < Tree<E>::N) </code>
    - <code> ! Root(). Same( o.Root() ) </code>

    \post
    - \c "o" deja de ser sub-árbol del árbol en que estaba
    - <code> o.Father() .Same( Root() ) </code>

    \remarks
    - Un sub-árbol puede ser hijo (o sub-árbol) de otro árbol
    - Un sub-árbol puede ser hijo únicamente de un árbol
    - Este método no hace nada cuando [ <code> ! Root() .Same( o.Root() ) </code> ]
    - Injertar un sub-árbol vacío es una forma de eliminar a un hijo junto con
      toda su descendencia

    \returns "o" ==> El árbol recién injertado

    \par Complejidad::
         O( \c Count_Children() ) + O( <code> o.Father().Count_Children() </code> ) */
template <class E>
Tree<E> Tree<E>::Graft(unsigned n, Tree &o) {
    if (m_root == 0) { // ignora árboles vacíos
        return Tree( );
    }
    if (m_root == o.m_root) { // evita auto-borrado
        return Tree( (NOT_null_pointer*) m_root );
    }
    #ifdef FALTA_verificar_en_Graft
        bool Ancestor( Tree & Child, Tree & Father );
        assert( ! Ancestor( o, *this ) ); // "o" no puede ser ancestro de *this"
    #endif
    if (n >= Tree<E>::N) { // ignora punteros nulos
        return Tree( (NOT_null_pointer*) m_root );
    }
    if (m_root->m_Lchild[n] == o.m_root) { // ya el hijo está ahí
        return Tree( (NOT_null_pointer*) m_root );
    }
    if (m_root->m_Lchild[n] != 0) {
        m_root->m_Lchild[n]->m_father = 0; // deja a este hijo [n] sin padre aunque...
        m_root->m_Lchild[n]->m_n_child = 0; // ...puede que haya otras referencias a este mismo nodo
        Erase0( m_root->m_Lchild[n] ); // elimna el n-ésimo hijo de "*this"
    }
    if (o.m_root == 0) {
        m_root->m_Lchild[n] = 0; // Caso trival si el árbol "o" a injertar está vacío
    } else {
        if (o.m_root->m_father != 0) { // desliga al hijo "o" de su padre actual
            o.m_root->m_father->m_Lchild[o.m_root->m_n_child] = 0; // ya no es hijo del padre anterior
            o.m_root->m_refCount--; // pues dejó de ser hijo del padre anterior
        }
        o.m_root->m_father = m_root; // nuevo padre
        o.m_root->m_n_child = n; // coloca a "o" como el "n-ésimo" hijo
        o.m_root->m_refCount++; // su nuevo padre ahora ya le apunta
        m_root->m_Lchild[n] = o.m_root;
    }

    return Tree( m_root->m_Lchild[n] );
} // Tree<E>::Graft()

} // namespace TV

#endif  // Tree_V_h

// EOF: Tree_V.h

---