EpetraExt_MatlabEngine.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
// 
//                       MATLAB Engine Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library 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
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
//@HEADER

#ifndef MATLAB_ENGINE_H
#define MATLAB_ENGINE_H
#include <Epetra_ConfigDefs.h>

#ifdef EPETRA_MPI
#include "Epetra_MpiComm.h"
#else
#include "Epetra_SerialComm.h"
#endif
#include "Epetra_Comm.h"

// the following deal with matlab provided headers:
#include "engine.h"
#include "mex.h"
#undef printf  // matlab has its own printf that we don't want to use

class Epetra_MultiVector;
class Epetra_RowMatrix;
class Epetra_CrsGraph;
class Epetra_SerialDenseMatrix;
class Epetra_BlockMap;
class Epetra_IntSerialDenseMatrix;
class Epetra_CrsMatrix;

namespace EpetraExt {


class EpetraExt_MatlabEngine {

  public:



  EpetraExt_MatlabEngine(const Epetra_Comm& Comm);

  ~EpetraExt_MatlabEngine();
  


  int EvalString (char* command, char* outputBuffer = NULL, int outputBufferSize = -1);




  int PutMultiVector(const Epetra_MultiVector& A, const char* variableName);


  int PutRowMatrix(const Epetra_RowMatrix& A, const char* variableName, bool transA);

  int PutCrsGraph(const Epetra_CrsGraph& A, const char* variableName, bool transA);


  int PutSerialDenseMatrix(const Epetra_SerialDenseMatrix& A, const char* variableName, int proc=0);


  int PutIntSerialDenseMatrix(const Epetra_IntSerialDenseMatrix& A, const char* variableName, int proc=0);


  int PutBlockMap(const Epetra_BlockMap& blockMap, const char* variableName, bool transA);
  

  int PutIntoMatlab(const char* variableName, mxArray* matlabA);




  int GetMultiVector(const char* variableName, Epetra_MultiVector& A);
  

  int GetSerialDenseMatrix(const char* variableName, Epetra_SerialDenseMatrix& A, int proc=0);
  

  int GetIntSerialDenseMatrix(const char* variableName, Epetra_IntSerialDenseMatrix& A, int proc=0);
  

  int GetCrsMatrix(const char* variableName, Epetra_CrsMatrix& A, bool getTrans);
  
    
    

  int GetmxArrayDimensions(mxArray* matlabA, bool& isSparse, int& numRows, int& numCols, int& numNonZeros);
  

  int GetmxArray(const char* variableName, mxArray** matlabA);
  

 private:
  // the Matlab Engine object provided by libeng and engine.h
  Engine* Engine_ ;
  // the Epetra_Comm object that will be used for all communication
  const Epetra_Comm& Comm_ ;

};
} // namespace EpetraExt

#endif /* MATLAB_ENGINE_H */