---

dim.h

//
// dim.h
//
// Copyright (C) 1996 Limit Point Systems, Inc.
//
// Author: Curtis Janssen <cljanss@limitpt.com>
// Maintainer: LPS
//
// This file is part of the SC Toolkit.
//
// The SC Toolkit is free software; you can redistribute it and/or modify
// it under the terms of the GNU Library General Public License as published by
// the Free Software Foundation; either version 2, or (at your option)
// any later version.
//
// The SC Toolkit 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 Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public License
// along with the SC Toolkit; see the file COPYING.LIB.  If not, write to
// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
//
// The U.S. Government is granted a limited license as per AL 91-7.
//

#ifdef __GNUC__
#pragma interface
#endif

#ifndef _math_scmat_dim_h
#define _math_scmat_dim_h

#include <util/keyval/keyval.h>
#include <util/state/state.h>

class RefSCDimension;
class SCBlockInfo: public SavableState {
  protected:
    int n_;
    int nblocks_;
    int *start_;
    int *size_;
    RefSCDimension *subdims_;
    void init_start();
  public:
    SCBlockInfo(int n, int nblocks = 0, const int *blocksizes = 0);
    SCBlockInfo(StateIn&);
    SCBlockInfo(const Ref<KeyVal>& keyval);

    ~SCBlockInfo();
    void save_data_state(StateOut&);

    int equiv(SCBlockInfo *bi);
    int nelem() const { return n_; }
    int nblock() const { return nblocks_; }
    int start(int i) const { return start_[i]; }
    int size(int i) const { return size_[i]; }
    int fence(int i) const { return start_[i] + size_[i]; }

    void elem_to_block(int i, int &block, int &offset);

    RefSCDimension subdim(int i);
    void set_subdim(int i, const RefSCDimension &dim);

    void print(std::ostream&o=ExEnv::out()) const;
};


class SCDimension: public SavableState {
  protected:
    char *name_;
    int n_;
    Ref<SCBlockInfo> blocks_;
    SCDimension(const char* name = 0);
  public:
    SCDimension(int n, const char* name = 0);
    SCDimension(const Ref<SCBlockInfo>&, const char *name = 0);
    SCDimension(int n, int nblocks, const int *blocksizes = 0,
                const char* name = 0);
    SCDimension(const Ref<KeyVal>&);
    SCDimension(StateIn&s);

    ~SCDimension();
    void save_data_state(StateOut&);

    int equiv(const SCDimension*) const;
    
    int n() const { return n_; }
    const char* name() const { return name_; }

    Ref<SCBlockInfo> blocks() { return blocks_; }

    void print(std::ostream&o=ExEnv::out()) const;
};

class RefSCDimension: public Ref<SCDimension> {
    // standard overrides
  public:
    RefSCDimension();
    RefSCDimension(const RefSCDimension& d);
    RefSCDimension(SCDimension *d);

    ~RefSCDimension();
    RefSCDimension& operator=(SCDimension* d);

    RefSCDimension& operator<<(RefCount*);
    RefSCDimension& operator<<(const RefBase &);
    RefSCDimension& operator=(const RefSCDimension & d);

    // dimension specific functions
  public:
    operator int() const;
    int n() const;

    void print(std::ostream&o=ExEnv::out()) const;
};

#endif

// Local Variables:
// mode: c++
// c-file-style: "CLJ"
// End:

---