bst.hpp

Go to the documentation of this file.

/*
 * $Id$
 * Copyright (C) 2019 John D Lamb
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#ifndef CCGSL_BST_HPP
#define CCGSL_BST_HPP
 
#include<gsl/gsl_bst.h>
 
#ifndef DOXYGEN_SKIP
namespace gsl {
  namespace bst {
    class workspace {
    public:
      workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit workspace( gsl_bst_type const* T, gsl_bst_allocator const* allocator,
              gsl_bst_cmp_function* compare, void* params ){
    ccgsl_pointer = gsl_bst_alloc( T, allocator, compare, params );
    // just plausibly we could allocate bst but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_bst_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit workspace( gsl_bst_workspace* v ){
    ccgsl_pointer = v;
    // just plausibly we could fail to allocate count: no further action needed.
    count = new size_t;
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      // copy constructor
      workspace( workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      workspace& operator=( workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_bst_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_bst_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      workspace( workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      workspace& operator=( workspace&& v ){
    workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( workspace const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( workspace const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( workspace const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( workspace const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( workspace const& v ) const { return ccgsl_pointer >= v.ccgsl_pointer; }
      bool empty() const { return ccgsl_pointer == 0; }
      // swap() --- should work even if sizes don't match
      void swap( workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_bst_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_bst_workspace* get() const { return ccgsl_pointer; }
      bool unique() const { return count != 0 and *count == 1; }
      size_t use_count() const { return count == 0 ? 0 : *count; }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      explicit
#endif
      operator bool() const { return ccgsl_pointer != 0; }
    };
    inline int empty( workspace& w ){ return gsl_bst_empty( w.get() ); } 
    inline void* insert( void* item, workspace& w ){ return gsl_bst_insert( item, w.get() ); }
    inline void* find( void const* item, workspace& w ){ return gsl_bst_find( item, w.get() ); } 
    inline void* remove( void const* item, workspace& w ){
      return gsl_bst_remove( item, w.get() ); } 
    inline size_t nodes( workspace& w ){ return gsl_bst_nodes( w.get() ); } 
    inline size_t node_size( workspace& w ){ return gsl_bst_node_size( w.get() ); } 
    inline char const* name( workspace& w ){ return gsl_bst_name( w.get() ); } 
    inline int trav_init( gsl_bst_trav* trav, workspace& w ){
      return gsl_bst_trav_init( trav, w.get() ); }
    inline void* trav_first( gsl_bst_trav* trav, workspace& w ){
      return gsl_bst_trav_first( trav, w.get() ); } 
    inline void* trav_last( gsl_bst_trav* trav, workspace& w ){
      return gsl_bst_trav_last( trav, w.get() ); } 
    inline void* trav_find( void const* item, gsl_bst_trav* trav, workspace& w ){
      return gsl_bst_trav_find( item, trav, w.get() ); } 
    inline void* trav_insert( void* item, gsl_bst_trav* trav, workspace& w ){
      return gsl_bst_trav_insert( item, trav, w.get() ); } 
    inline void* trav_copy( gsl_bst_trav* dest, gsl_bst_trav const* src ){
      return gsl_bst_trav_copy( dest, src ); } 
    inline void* trav_next( gsl_bst_trav* trav ){ return gsl_bst_trav_next( trav ); } 
    inline void* trav_prev( gsl_bst_trav* trav ){ return gsl_bst_trav_prev( trav ); } 
    inline void* trav_cur( gsl_bst_trav const* trav ){ return gsl_bst_trav_cur( trav ); } 
    inline void* trav_replace( gsl_bst_trav* trav, void* new_item ){
      return gsl_bst_trav_replace( trav, new_item ); }
  }
}
#endif /* DOXYGEN_SKIP */
#endif