include/ds/SymmetricSparse.h

#ifndef _SYMMETRICSPARSE_H_
#define _SYMMETRICSPARSE_H_
// ---------------------------------------------
// company   : 
// user      : 
// date      : 22 Mar 2015 17:21
// file      : SymmetricSparse.h
// markers   : Full
// language  : C++
// generator : Metamill 6.0
// ---------------------------------------------

//#UBLK-BEG-HEADERH
//==============================================================
// Description : 
//--------------------------------------------------------------
// Author      : Gilberto Luis
// Created     : 16 Dez 2010
//--------------------------------------------------------------
// Change history : 
//   16 Dez 2010 (Gilberto Luis) Initial version generated
//
//==============================================================
//#UBLK-END-HEADERH

/*=================================================================================================
=                                                                                                 =
=       Copyright 2010-2015  Marco Lucio Bittencourt / Fabiano Fernandes Bargos                       =
=                        Gilberto Luis Valente / Jorge Luis Suzuki / Allan Patrick Cordeiro Dias  =
=                                                                                                 =
=       Licensed under the Apache License, Version 2.0 (the "License");                               =
=       you may not use this file except in compliance with the License.                              =
=       You may obtain a copy of the License at                                                       =
=                                                                                                 =
=               http://www.apache.org/licenses/LICENSE-2.0                                                =
=                                                                                                 =
=       Unless required by applicable law or agreed to in writing, software                           =
=       distributed under the License is distributed on an "AS IS" BASIS,                             =
=       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.                      =
=       See the License for the specific language governing permissions and                           =
=       limitations under the License.                                                                =
=                                                                                                 =
=================================================================================================*/


typedef struct {
        double Value;
        long Col;
#ifdef __16BITS__
        long dummy;
#endif
} SSM_T;


#include <cstdio>
#include "ds/SymmetricMatrix.h"


class SymmetricSparse
{
//#UBLK-BEG-CLASSDEF mm:22ed489e-c5b9-11df-8d40-e1925b19f1b8
//#UBLK-END-CLASSDEF

 public:

   // METHOD=mm:22ed4a4c-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse();

   // METHOD=mm:22ed4a4d-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse(long MatrixOrder, long* Diagonal, long* Columns, double InitValue = 0.0);

   // METHOD=mm:22ed4a4e-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse(long MatrixOrder, long* Diagonal, long* Columns, double* Elements);

   // METHOD=mm:22ed4a4f-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse(FILE* File);

   // METHOD=mm:22ed4a54-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse(SymmetricSparse& Instance);

   // METHOD=mm:22ed4a55-c5b9-11df-8d40-e1925b19f1b8
   ~SymmetricSparse();

   // METHOD=mm:22ed4a56-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse& operator=(SymmetricSparse& Instance);

   // METHOD=mm:22ed4a57-c5b9-11df-8d40-e1925b19f1b8
   SymmetricSparse& Equal(SymmetricSparse& Instance);

   // METHOD=mm:22ed4a58-c5b9-11df-8d40-e1925b19f1b8
   operator SSM_T*const();

   // METHOD=mm:22ed4a59-c5b9-11df-8d40-e1925b19f1b8
   operator long*const();

   // METHOD=mm:22ed4a5e-c5b9-11df-8d40-e1925b19f1b8
   double& operator()(long Row, long Col);

   // METHOD=mm:22ed4a5f-c5b9-11df-8d40-e1925b19f1b8
   double& GetElement(unsigned long Row, unsigned long Column);

   // METHOD=mm:22ed4a60-c5b9-11df-8d40-e1925b19f1b8
   void SetOrder(unsigned long MatrixOrder, long* Diagonal = NULL, double Value = 0.0);

   // METHOD=mm:22ed4a61-c5b9-11df-8d40-e1925b19f1b8
   void SetOrder(unsigned long MatrixOrder, long NumberElements, double Value = 0.0);

   // METHOD=mm:22ed4a62-c5b9-11df-8d40-e1925b19f1b8
   unsigned long GetOrder();

   // METHOD=mm:22ed4a63-c5b9-11df-8d40-e1925b19f1b8
   unsigned long GetNumberElements();

   // METHOD=mm:22ed4a68-c5b9-11df-8d40-e1925b19f1b8
   long GetAverElementsLine();

   // METHOD=mm:22ed4a69-c5b9-11df-8d40-e1925b19f1b8
   void GetMaxMinDiagElems(double& MinDiagValue, double& MaxDiagValue);

   // METHOD=mm:22ed4a6a-c5b9-11df-8d40-e1925b19f1b8
   void GetTopology(long& MatrixOrder, long& NumberElements, long& MaxNumberElLine, long& MinNumberElLine, long& AverNumberElLine);

   // METHOD=mm:22ed4a6b-c5b9-11df-8d40-e1925b19f1b8
   long SizeOf();

   // METHOD=mm:22ed4a6c-c5b9-11df-8d40-e1925b19f1b8
   void Reset(double Value = 0.0);

   // METHOD=mm:22ed4a6d-c5b9-11df-8d40-e1925b19f1b8
   void Insert(SymmetricMatrix& SubMatrix, long* LineCol);

   // METHOD=mm:250c04f5-c154-49fb-ad30-5c374b38c041
   void Insert(SymmetricMatrix& SubMatrix, long* LineCol, unsigned long InitLineCol);

   // METHOD=mm:22ed4a72-c5b9-11df-8d40-e1925b19f1b8
   void Multiplicate(double* X, double* Y);

   // METHOD=mm:b2849a7e-eacf-44ce-9c01-197ceaa7220d
   void Multiplicate(double scalar);

   // METHOD=mm:a0e491d5-7354-426c-a8fc-f05bd66ccd04
   void Add(SymmetricSparse& A, SymmetricSparse& B);

   // METHOD=mm:84f41d88-7532-4caa-b7e5-4deb903a9e11
   void Add(SymmetricSparse& A);

   // METHOD=mm:22ed4a73-c5b9-11df-8d40-e1925b19f1b8
   void Save(FILE* File);

   // METHOD=mm:22ed4a74-c5b9-11df-8d40-e1925b19f1b8
   void Save(char* TabName, int Version, char* Filename);

   // METHOD=mm:22ed4a75-c5b9-11df-8d40-e1925b19f1b8
   void Restore(FILE* File);

   // METHOD=mm:22ed4a76-c5b9-11df-8d40-e1925b19f1b8
   void Restore(char* TabName, int Version, char* Filename);

   // METHOD=mm:22ed4a77-c5b9-11df-8d40-e1925b19f1b8
   void Print(FILE* File, int Mant, int Dec);

   // METHOD=mm:22ed4a7c-c5b9-11df-8d40-e1925b19f1b8
   void Print(FILE* File = stdout, const char* Message = "", int NumMaxCols = 5, int Mant = 14, int Dec = 7);

   // METHOD=mm:22ed4a7d-c5b9-11df-8d40-e1925b19f1b8
   void PrintTopology(FILE* File);

   // METHOD=mm:22ed4a7e-c5b9-11df-8d40-e1925b19f1b8
   void Free();

   // METHOD=mm:22ed4a7f-c5b9-11df-8d40-e1925b19f1b8
   void GaussSolver(double* U, double* B, double Precision);

   // METHOD=mm:22ed4a80-c5b9-11df-8d40-e1925b19f1b8
   void GaussSolver(double Precision = 1e-12);

   // METHOD=mm:22ed4a81-c5b9-11df-8d40-e1925b19f1b8
   void GaussSolver(double* U, double* B);

   // METHOD=mm:22ed4a86-c5b9-11df-8d40-e1925b19f1b8
   long Jacobi(double* U, double* B, unsigned long MaxNumberIter, double& NormRes, double Precision = 1e-4, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);

   // METHOD=mm:22ed4a87-c5b9-11df-8d40-e1925b19f1b8
   long Jacobi(double* U, double* B, unsigned long MaxNumberIter);

   // METHOD=mm:22ed4a88-c5b9-11df-8d40-e1925b19f1b8
   long GaussSeidel(double* U, double* B, unsigned long MaxNumberIter, double& NormRes, double Precision = 1e-4, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);

   // METHOD=mm:22ed4a89-c5b9-11df-8d40-e1925b19f1b8
   long GaussSeidel(double* U, double* B, unsigned long NumberIter);

   // METHOD=mm:22ed4a8a-c5b9-11df-8d40-e1925b19f1b8
   long SOR(double* U, double* B, long MaxNumberIter, double& NormRes, double Precision = 1e-4, double Omega = 1.81, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);

   // METHOD=mm:22ed4a90-c5b9-11df-8d40-e1925b19f1b8
   long CG(double* U, double* B, long MaxNumberIter, double& NormRes, double Precision = 1e-4, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);

   // METHOD=mm:22ed4a91-c5b9-11df-8d40-e1925b19f1b8
   long CGDiagonal(double* U, double* B, long MaxNumberIter, double& NormRes, double Precision = 1e-4, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);

   // METHOD=mm:22ed4a92-c5b9-11df-8d40-e1925b19f1b8
   long CGPreConditionated(double* U, double* B, long MaxNumberIter, double& NormRes, double Precision = 1e-4, double Omega = 1.81, PreMatrix_E PreMatrix = SGS, ConvCriterion_E Crit = WEIGHT_RESIDUE, NormDS_E Norm = EUCLID);


 protected:

   // METHOD=mm:22ed4a38-c5b9-11df-8d40-e1925b19f1b8
   void FreeAuxVectors();

   // METHOD=mm:22ed4a39-c5b9-11df-8d40-e1925b19f1b8
   void AllocDiag(long* Diagonal = NULL);

   // METHOD=mm:22ed4a3a-c5b9-11df-8d40-e1925b19f1b8
   void Alloc(double InitValue = 0.0);

   // METHOD=mm:22ed4a3b-c5b9-11df-8d40-e1925b19f1b8
   unsigned long GetNumElLine(long Lin);

   // METHOD=mm:22ed4a40-c5b9-11df-8d40-e1925b19f1b8
   void TopologyEvaluation();

   // METHOD=mm:22ed4a41-c5b9-11df-8d40-e1925b19f1b8
   void MaxMinDiagEvaluation();

   // METHOD=mm:22ed4a42-c5b9-11df-8d40-e1925b19f1b8
   int ConvCriteria(double* U, double* Un, double* b, double Prec, double Normb, ConvCriterion_E Crit, NormDS_E Norm, double& NormRes);

   // METHOD=mm:22ed4a43-c5b9-11df-8d40-e1925b19f1b8
   void prodauxsk(double* X, double* Y, double cte);

   // METHOD=mm:22ed4a44-c5b9-11df-8d40-e1925b19f1b8
   void bcksbstsk(double* U, double* B, double omega);

   // METHOD=mm:22ed4a45-c5b9-11df-8d40-e1925b19f1b8
   void fwdsbstsk(double* U, double* B, double omega);

   // METHOD=mm:22ed4a4a-c5b9-11df-8d40-e1925b19f1b8
   void prodfx(double* Z, double* X, double Omega);

   // METHOD=mm:22ed4a4b-c5b9-11df-8d40-e1925b19f1b8
   void prauxsk(double* U, double* B);

   // METHOD=mm:51bfc0d4-4c15-4e46-ac19-3b8fd4906c2c
   double norinfv(double* u, long dim);

   // METHOD=mm:85936cd7-b174-47a2-987c-df62b345065b
   double scalv(double* x, double* y, unsigned long dim);

   // METHOD=mm:0a638307-7e42-4649-8dde-d16b47fb1898
   double normaev(double* u, long dim);


   // attr=mm:22ed4a23-c5b9-11df-8d40-e1925b19f1b8
   unsigned long PolyOrder;

   // attr=mm:22ed4a25-c5b9-11df-8d40-e1925b19f1b8
   unsigned long MaxNumElLine;

   // attr=mm:22ed4a26-c5b9-11df-8d40-e1925b19f1b8
   unsigned long MinNumElLine;

   // attr=mm:22ed4a2f-c5b9-11df-8d40-e1925b19f1b8
   long* Pos;

   // attr=mm:22ed4a24-c5b9-11df-8d40-e1925b19f1b8
   long* Diag;

   // attr=mm:22ed4a30-c5b9-11df-8d40-e1925b19f1b8
   double* d;

   // attr=mm:22ed4a31-c5b9-11df-8d40-e1925b19f1b8
   double* f;

   // attr=mm:22ed4a36-c5b9-11df-8d40-e1925b19f1b8
   double* g;

   // attr=mm:22ed4a37-c5b9-11df-8d40-e1925b19f1b8
   double* h;

   // attr=mm:22ed4a2d-c5b9-11df-8d40-e1925b19f1b8
   SSM_T* SSMatrix;

   // attr=mm:22ed4a27-c5b9-11df-8d40-e1925b19f1b8
   double MaxDiagElem;

   // attr=mm:22ed4a2c-c5b9-11df-8d40-e1925b19f1b8
   double MinDiagElem;

   // attr=mm:22ed4a2e-c5b9-11df-8d40-e1925b19f1b8
   static double Zero;


 private:

//#UBLK-BEG-CLASSMEMB mm:22ed489e-c5b9-11df-8d40-e1925b19f1b8
//#UBLK-END-CLASSMEMB
};

//#UBLK-BEG-GLOBALH
//*** Removed methods: 15 Mar 2011 15:51
//---
//uuid=mm:22ed4a8b-c5b9-11df-8d40-e1925b19f1b8
//   long ChebyshevSSOR(double* U, double* B, long MaxNumberIter, double& NormRes, double me, double Me, double F = 0.8, double d = 0.1, double Precision = 1e-4, double Omega = 1.81, ConvCriterion_E Crit = WEIGHT_RESIDUE, Norm_E Norm = EUCLIDEAN);

//*** Removed methods: 30 Dec 2014 15:52
//---
//uuid=mm:e94730c7-bd1a-46db-b698-2725f62386a1
//   void SparseToMatrix(FILE* File, int Mant, int Dec);

//*** Removed methods: 21 Mar 2015 21:18
//---
//uuid=mm:fd6f875b-073f-4761-a964-6b8880a2641a
//   void SparseToMatrix(FILE* File = stdout, const char* Message = "", int NumMaxCols = 5, int Mant = 14, int Dec = 7);

//#UBLK-END-GLOBALH


#endif // _SYMMETRICSPARSE_H_