trunk/ascxx/incidencematrix.h

#ifndef ASCXX_INCIDENCEMATRIX_H
#define ASCXX_INCIDENCEMATRIX_H

#include <vector>

#include "variable.h"
#include "relation.h"
#include "simulation.h"
#include "solverstatus.h"

#include "config.h"

extern "C"{
#include <ascend/system/incidence.h>
}

typedef enum{
    IM_NULL=0, IM_ACTIVE_FIXED, IM_ACTIVE_FREE, IM_DORMANT_FIXED, IM_DORMANT_FREE
} IncidencePointType;

typedef enum{
    IM_CONVERGED=0, IM_OVER_ITER, IM_OVER_TIME, IM_DIVERGED, IM_NOT_YET_ATTEMPTED
} BlockStatusType;

class IncidencePoint{
public:
    IncidencePoint(const int&row, const int&col, const IncidencePointType &type);
    IncidencePoint(const IncidencePoint &);
    IncidencePoint();

    int row;
    int col;
    IncidencePointType type;
};

/**
    Special class for plotting incidence matrices using matplotlib

    GOAL: facilitate use of pylab 'spy2' function, but hopefully add extra
    stuff for viewing blocks and fixed/free incidences, solved/active/unsolved
    variables, etc.

    This is going to be like a C++ified copy of MtxProc.c
*/
class IncidenceMatrix{

private:
    Simulation &sim;
    slv_system_t sys;

    std::vector<IncidencePoint> data;
    incidence_vars_t i;
    bool is_built;

    void buildPlotData();
public:
    explicit IncidenceMatrix(Simulation &sim);
    ~IncidenceMatrix();

    const std::vector<IncidencePoint> &getIncidenceData();
    const int &getNumRows() const;
    const int &getNumCols() const;
    const Variable getVariable(const int &row) const;
    const Relation getRelation(const int &col) const;
    const int getBlockRow(const int & row) const;
    const std::vector<Variable> getBlockVars(const int &block);
    const std::vector<Relation> getBlockRels(const int &block);
    const std::vector<int> getBlockLocation(const int &block) const;
    const BlockStatusType getBlockStatus(const int &block) const;
    const int getNumBlocks();
};

#endif // ASCXX_INCIDENCEMATRIX_H
1	#ifndef ASCXX_INCIDENCEMATRIX_H
2	#define ASCXX_INCIDENCEMATRIX_H
3
4	#include <vector>
5
6	#include "variable.h"
7	#include "relation.h"
8	#include "simulation.h"
9	#include "solverstatus.h"
10
11	#include "config.h"
12
13	extern "C"{
14	#include <ascend/system/incidence.h>
15	}
16
17	typedef enum{
18	IM_NULL=0, IM_ACTIVE_FIXED, IM_ACTIVE_FREE, IM_DORMANT_FIXED, IM_DORMANT_FREE
19	} IncidencePointType;
20
21	typedef enum{
22	IM_CONVERGED=0, IM_OVER_ITER, IM_OVER_TIME, IM_DIVERGED, IM_NOT_YET_ATTEMPTED
23	} BlockStatusType;
24
25	class IncidencePoint{
26	public:
27	IncidencePoint(const int&row, const int&col, const IncidencePointType &type);
28	IncidencePoint(const IncidencePoint &);
29	IncidencePoint();
30
31	int row;
32	int col;
33	IncidencePointType type;
34	};
35
36	/**
37	Special class for plotting incidence matrices using matplotlib
38
39	GOAL: facilitate use of pylab 'spy2' function, but hopefully add extra
40	stuff for viewing blocks and fixed/free incidences, solved/active/unsolved
41	variables, etc.
42
43	This is going to be like a C++ified copy of MtxProc.c
44	*/
45	class IncidenceMatrix{
46
47	private:
48	Simulation &sim;
49	slv_system_t sys;
50
51	std::vector<IncidencePoint> data;
52	incidence_vars_t i;
53	bool is_built;
54
55	void buildPlotData();
56	public:
57	explicit IncidenceMatrix(Simulation &sim);
58	~IncidenceMatrix();
59
60	const std::vector<IncidencePoint> &getIncidenceData();
61	const int &getNumRows() const;
62	const int &getNumCols() const;
63	const Variable getVariable(const int &row) const;
64	const Relation getRelation(const int &col) const;
65	const int getBlockRow(const int & row) const;
66	const std::vector<Variable> getBlockVars(const int &block);
67	const std::vector<Relation> getBlockRels(const int &block);
68	const std::vector<int> getBlockLocation(const int &block) const;
69	const BlockStatusType getBlockStatus(const int &block) const;
70	const int getNumBlocks();
71	};
72
73	#endif // ASCXX_INCIDENCEMATRIX_H