IBooleanMatrix Interface Reference

Interface for boolean matrices. More...

Inheritance diagram for IBooleanMatrix:

List of all members.

Public Member Functions
IList< int >	GetEntriesByColumn (int column_id)
	Get all true entries (row IDs) of a column.
IList< int >	GetEntriesByRow (int row_id)
	Get all true entries (column IDs) of a row.
int	NumEntriesByColumn (int column_id)
	Get all the number of entries in a column.
int	NumEntriesByRow (int row_id)
	Get all the number of entries in a row.
int	Overlap (IBooleanMatrix s)
	Get the overlap of two matrices, i.e. the number of true entries where they agree.
Properties
IList< int >	NonEmptyColumnIDs [get]
	The IDs of the non-empty columns in the matrix (the ones that contain at least one true entry).
IList< int >	NonEmptyRowIDs [get]
	The IDs of the non-empty rows in the matrix (the ones that contain at least one true entry).
int	NumberOfEntries [get]
	The number of (true) entries.
ICollection< int >	this [int x] [get]
	Indexer to access the rows of the matrix.

---

Detailed Description

Interface for boolean matrices.

---

Member Function Documentation

IList<int> GetEntriesByColumn

(

int

column_id

)

Get all true entries (row IDs) of a column.

Parameters:

column_id

the column ID

Returns:

a list of row IDs

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

IList<int> GetEntriesByRow

(

int

row_id

)

Get all true entries (column IDs) of a row.

Parameters:

row_id

the row ID

Returns:

a list of column IDs

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

int NumEntriesByColumn

(

int

column_id

)

Get all the number of entries in a column.

Parameters:

column_id

the column ID

Returns:

the number of entries in column column_id

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

int NumEntriesByRow

(

int

row_id

)

Get all the number of entries in a row.

Parameters:

row_id

the row ID

Returns:

the number of entries in row row_id

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

int Overlap

(

IBooleanMatrix

s

)

Get the overlap of two matrices, i.e. the number of true entries where they agree.

Parameters:

s

the IBooleanMatrix to compare to

Returns:

the number of entries that are true in both matrices

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

---

Property Documentation

IList<int> NonEmptyColumnIDs [get]

The IDs of the non-empty columns in the matrix (the ones that contain at least one true entry).

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

IList<int> NonEmptyRowIDs [get]

The IDs of the non-empty rows in the matrix (the ones that contain at least one true entry).

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

int NumberOfEntries [get]

The number of (true) entries.

Implemented in SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, and SparseBooleanMatrixStatic.

ICollection<int> this[int x] [get]

Indexer to access the rows of the matrix.

Parameters:

x

the row ID

Implemented in SparseBooleanMatrix, SparseBooleanMatrix, SparseBooleanMatrixBinarySearch, SparseBooleanMatrixBinarySearch, SparseBooleanMatrixStatic, and SparseBooleanMatrixStatic.

---

The documentation for this interface was generated from the following file:

• IBooleanMatrix.cs