com.stata.sfi

Class Mata

java.lang.Object

com.stata.sfi.Mata

public final class Mata
extends Object

Routines for interacting with a Mata matrix.

Method Summary

Methods

Modifier and Type	Method and Description
static int	getMataCol(String name) Deprecated.
static long	getMataColTotal(String name) Get the number of columns in a Mata matrix.
static double[]	getMataComp(String name) Deprecated.
static double[]	getMataCompAt(String name, int row, int col) Deprecated.
static double[]	getMataCompAt(String name, long row, long col) Read a complex Mata matrix entry.
static String	getMataEltype(String name) Get the type of a Mata object.
static double[]	getMataReal(String name) Deprecated.
static double	getMataRealAt(String name, int row, int col) Deprecated.
static double	getMataRealAt(String name, long row, long col) Read a real Mata matrix entry.
static int	getMataRow(String name) Deprecated.
static long	getMataRowTotal(String name) Get the number of rows in a Mata matrix.
static String[]	getMataString(String name) Deprecated.
static String	getMataStringAt(String name, int row, int col) Deprecated.
static String	getMataStringAt(String name, long row, long col) Read a string Mata matrix entry.

Methods inherited from class java.lang.Object

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

Method Detail

getMataCol

@Deprecated
public static int getMataCol(String name)

Deprecated.

Get the number of columns in a Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

The number of columns. Returns -1 if an error occurs.

getMataColTotal

public static long getMataColTotal(String name)

Get the number of columns in a Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

The number of columns. Returns -1 if an error occurs.

getMataComp

@Deprecated
public static double[] getMataComp(String name)

Deprecated.

Read a complex Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

A double array containing the matrix values. Returns null if an error occurs.

getMataCompAt

@Deprecated
public static double[] getMataCompAt(String name,
                                int row,
                                int col)

Deprecated.

Read a complex Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

A double[2] containing the entry. Returns null if an error occurs.

getMataCompAt

public static double[] getMataCompAt(String name,
                     long row,
                     long col)

Read a complex Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

A double[2] containing the entry. Returns null if an error occurs.

getMataEltype

public static String getMataEltype(String name)

Get the type of a Mata object.

Parameters:

name - Name of the Mata matrix (not function).

Returns:

The eltype in string form of the Mata object. Returns an empty String if an error occurs.

getMataReal

@Deprecated
public static double[] getMataReal(String name)

Deprecated.

Read a real Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

A double array containing the matrix values. Returns null if an error occurs.

getMataRealAt

@Deprecated
public static double getMataRealAt(String name,
                              int row,
                              int col)

Deprecated.

Read a real Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

Returns the entry. Returns a Stata missing if an error occurs.

getMataRealAt

public static double getMataRealAt(String name,
                   long row,
                   long col)

Read a real Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

Returns the entry. Returns a Stata missing if an error occurs.

getMataRow

@Deprecated
public static int getMataRow(String name)

Deprecated.

Get the number of rows in a Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

The number of rows. Returns -1 if an error occurs.

getMataRowTotal

public static long getMataRowTotal(String name)

Get the number of rows in a Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

The number of rows. Returns -1 if an error occurs.

getMataString

@Deprecated
public static String[] getMataString(String name)

Deprecated.

Read a string Mata matrix.

Parameters:

name - Name of the Mata matrix.

Returns:

A String array containing the matrix values. Returns null if an error occurs.

getMataStringAt

@Deprecated
public static String getMataStringAt(String name,
                                int row,
                                int col)

Deprecated.

Read a string Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

A String containing the matrix entry. Returns an empty String if an error occurs.

getMataStringAt

public static String getMataStringAt(String name,
                     long row,
                     long col)

Read a string Mata matrix entry.

Parameters:

name - Name of the Mata matrix.

row - Row.

col - Column.

Returns:

A String containing the matrix entry. Returns an empty String if an error occurs.