org.paces.Stata.Matrices

Class MataMatrix

java.lang.Object

org.paces.Stata.Matrices.MataMatrix

public class MataMatrix
extends java.lang.Object

Class used to construct POJO representation of Mata Matrix.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.Long>	colindex List of column indices
java.lang.String	matName Name of the Mata matrix
java.util.Map<java.lang.Long,java.util.Map<java.lang.Long,java.lang.Object>>	matrix POJO representation of the Mata matrix
long	ncols Number of columns in the matrix
long	nrows Number of rows in the matrix
java.util.List<java.lang.Long>	rowindex List of row indices

Constructor Summary

Constructors

Constructor and Description
MataMatrix() Constructor method used to build the MataMatrix object

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Long>	getColIndex() Getter method to access the column indices
java.lang.String	getMatName() Getter method to access the name of the matrix
java.lang.Object	getMatrix() Getter method to access the POJO representation of the Mata Matrix
java.lang.Object	getMatrixData(java.lang.Long colid, java.lang.Long rowid) Generic method to return data from a Mata Matrix
java.lang.Long	getNcols() Getter method to access the total number of columns
java.lang.Long	getNrows() Getter method to access the total number of rows
java.util.List<java.lang.Long>	getRowIndex() Getter method to access the row indices
void	setColIndex(java.lang.Long ncol) Setter method for the colindex member variable
void	setMatName() Setter method for the name of the matrix accessed from a local macro defined during prior to calling the javacall function from Stata.
void	setMatrix(java.util.List<java.lang.Long> observations, java.util.List<java.lang.Long> variables) Method used to construct a POJO representation of the Mata matrix
void	setNcols(java.lang.String matrixName) Setter method for the number of columns in the named Mata Matrix
void	setNrows(java.lang.String matrixName) Setter method for the number of rows in the named Mata Matrix
void	setRowIndex(java.lang.Long nrow) Setter method for the rowindex member variable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ncols

public long ncols

Number of columns in the matrix

nrows

public long nrows

Number of rows in the matrix

matName

public java.lang.String matName

Name of the Mata matrix

colindex

public java.util.List<java.lang.Long> colindex

List of column indices

rowindex

public java.util.List<java.lang.Long> rowindex

List of row indices

matrix

public java.util.Map<java.lang.Long,java.util.Map<java.lang.Long,java.lang.Object>> matrix

POJO representation of the Mata matrix

Constructor Detail

MataMatrix

MataMatrix()

Constructor method used to build the MataMatrix object

Method Detail

setMatName

public void setMatName()

Setter method for the name of the matrix accessed from a local macro defined during prior to calling the javacall function from Stata.

getMatName

public java.lang.String getMatName()

Getter method to access the name of the matrix

Returns:

A string object containing the name of the matrix originally passed from the javacall function in Stata

setNcols

public void setNcols(java.lang.String matrixName)

Setter method for the number of columns in the named Mata Matrix

Parameters:

matrixName - The name of the Mata Matrix stored in the matName variable.

getNcols

public java.lang.Long getNcols()

Getter method to access the total number of columns

Returns:

A Long object with the value of the number of columns

setNrows

public void setNrows(java.lang.String matrixName)

Setter method for the number of rows in the named Mata Matrix

Parameters:

matrixName - The name of the Mata Matrix stored in the matName variable.

getNrows

public java.lang.Long getNrows()

Getter method to access the total number of rows

Returns:

A Long object with the value of the number of rows

setColIndex

public void setColIndex(java.lang.Long ncol)

Setter method for the colindex member variable

Parameters:

ncol - The number of columns in the Matrix previously named

getColIndex

public java.util.List<java.lang.Long> getColIndex()

Getter method to access the column indices

Returns:

A List of long values identifying columns of the previously named Mata matrix

setRowIndex

public void setRowIndex(java.lang.Long nrow)

Setter method for the rowindex member variable

Parameters:

nrow - The number of rows in the Matrix previously named

getRowIndex

public java.util.List<java.lang.Long> getRowIndex()

Getter method to access the row indices

Returns:

A List of long objects identifying individual rows of the Mata Matrix

setMatrix

public void setMatrix(java.util.List<java.lang.Long> observations,
                      java.util.List<java.lang.Long> variables)

Method used to construct a POJO representation of the Mata matrix

Parameters:

observations - A List of row indices

variables - A List of column indices

getMatrix

public java.lang.Object getMatrix()

Getter method to access the POJO representation of the Mata Matrix

Returns:

A POJO representation of the Mata Matrix

getMatrixData

public java.lang.Object getMatrixData(java.lang.Long colid,
                                      java.lang.Long rowid)

Generic method to return data from a Mata Matrix

Parameters:

colid - The value of the matrix column from which to obtain a value

rowid - The value of the matrix row from which to obtain a value

Returns:

A POJO containing the value for X[m, n]; The method returns a value of class Object regardless of whether the type is complex, real, or string.