/home/rex/ebltrunk/core/libidx/include/srg.h

/***************************************************************************
 *   Copyright (C) 2008 by Yann LeCun and Pierre Sermanet *
 *   yann@cs.nyu.edu, pierre.sermanet@gmail.com *
 *   All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Redistribution under a license not approved by the Open Source
 *       Initiative (http://www.opensource.org) must display the
 *       following acknowledgement in all advertising material:
 *        This product includes software developed at the Courant
 *        Institute of Mathematical Sciences (http://cims.nyu.edu).
 *     * The names of the authors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ThE AUTHORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ***************************************************************************/

#ifndef _SRG_H
#define _SRG_H

#include <stdio.h>

#include "defines.h"
#include "stl.h"
#include "smart.h"

namespace ebl {

  // srg: storage area for idx data.

  template <typename T> class srg : public smart_pointer {
  public:
    srg();
    srg(intg s);
    ~srg();
    intg size();
    intg changesize(intg s);
    intg growsize(intg s);
    intg growsize_chunk(intg s, intg s_chunk);

    /* //! decrement reference counter and deallocate srg */
    /* //! if it reaches zero. */
    /* int unlock(); */
    /* //! lock: increment reference counter. */
    /* //! This is called wheneve a new idx is created */
    /* //! on the srg. */
    /* int lock(); */

    T get(intg i);
    T* get_data();
    void set_data(T* ptr);
    void set(intg i, T val);
    void clear();
    void pretty(FILE *f);

    // friends /////////////////////////////////////////////////////////////////
    template <typename T2> friend class idx;
    template <typename T2> friend class idxiter;
    template <typename T2> friend class noncontiguous_idxiter;
    template <typename T2> friend class contiguous_idxiter;
    template <typename T2> friend class idxlooper;
    
    // member variables ////////////////////////////////////////////////////////
  private:
    T *data; 
    intg size_; 

    //    int refcount; //!< Reference counter: tells us how many idx point here.

    // debug only //////////////////////////////////////////////////////////////
#ifdef __DEBUGMEM__
  public:
    static intg memsize;
#endif    
  };

} // end namespace ebl

#include "srg.hpp"

#endif  /* _SRG_H */