Warning: This is no longer the latest available version of this module. Please see the releases page for the most recent version. The Webnucleo group strongly recommends the use of the latest version of any of its online modules.
This tutorial demonstrates how to use the example codes in the wn_matrix distribution src/examples directory. The sample input files used in the tutorial are included in the distribution release and may be located in the data_pub directory.
Example 1: Create a matrix, store elements, and scale them.
wn_matrix routines demonstrated in example1.c are:
- Line 36: WnMatrix__new()
- Line 45: WnMatrix__assignElement()
- Line 57: WnMatrix__removeElement()
- Line 80: WnMatrix__getElement()
- Line 89: WnMatrix__getNumberOfElements()
- Line 96: WnMatrix__scaleMatrix()
- Line 130: WnMatrix__clear()
- Line 154: WnMatrix__free()
To run example1, type the following on the command line:
./example1 > ex1_output.txt
The result is ex1_output.txt
Example 2: Print out a matrix to a file.
wn_matrix routines demonstrated in example2.c are:
- Line 55: WnMatrix__new()
- Line 64: WnMatrix__assignElement()
- Line 77: WnMatrix__writeMatrixToAsciiFile()
- Line 86: WnMatrix__free()
To run example2, type the following on the command line:
./example2 2.0 ex2_output.txt
The result is ex2_output.txt
Example 3: Convert a matrix to compressed row format.
wn_matrix routines demonstrated in example3.c are:
- Line 59: WnMatrix__new()
- Line 68: WnMatrix__assignElement()
- Line 80: WnMatrix__getCsr()
- Line 96: WnMatrix__Csr__getRowPointerVector()
- Line 106: WnMatrix__getNumberOfElements()
- Line 114: WnMatrix__Csr__getColumnVector()
- Line 115: WnMatrix__Csr__getValueVector()
- Line 126: WnMatrix__Csr__free()
- Line 132: WnMatrix__getCoo()
- Line 147: WnMatrix__Coo__getRowVector()
- Line 148: WnMatrix__Coo__getColumnVector()
- Line 149: WnMatrix__Coo__getValueVector()
- Line 160: WnMatrix__Coo__free()
- Line 161: WnMatrix__free()
To run example3, type the following on the command line:
./example3 ex3_output.txt
The result is ex3_output.txt
Example 4: Convert a matrix to Yale sparse format.
wn_matrix routines demonstrated in example4.c are:
- Line 56: WnMatrix__new()
- Line 65: WnMatrix__assignElement()
- Line 77: WnMatrix__getYale()
- Line 79: WnMatrix__Yale__getPointerVector()
- Line 80: WnMatrix__Yale__getValueVector()
- Line 93: WnMatrix__getNumberOfRows()
- Line 103: WnMatrix__getNumberOfElements()
- Line 130: WnMatrix__getElement()
- Line 142: WnMatrix__Yale__free()
- Line 143: WnMatrix__free()
To run example4, type the following on the command line:
./example4 ex4_output.txt
The result is ex4_output.txt
Example 5: Multiply a matrix by a vector and a transpose matrix by a vector.
wn_matrix routines demonstrated in example5.c are:
- Line 39: WnMatrix__new()
- Line 48: WnMatrix__assignElement()
- Line 78: WnMatrix__getMatrixTimesVector()
- Line 99: WnMatrix__getElement()
- Line 127: WnMatrix__getTransposeMatrixTimesVector()
- Line 175: WnMatrix__free()
To run example5, type the following on the command line:
./example5 > ex5_output.txt
The result is ex5_output.txt
Example 6: Insert a smaller matrix into a larger one and extract a smaller matrix from a larger one.
wn_matrix routines demonstrated in example6.c are:
- Line 59: WnMatrix__new()
- Line 74: WnMatrix__assignElement()
- Line 86: WnMatrix__insertMatrix()
- Line 94: WnMatrix__getDenseMatrix()
- Line 111: WnMatrix__getElement()
- Line 144: WnMatrix__free()
- Line 150: WnMatrix__extractMatrix()
- Line 161: WnMatrix__getNumberOfRows()
- Line 166: WnMatrix__getNumberOfColumns()
To run example6, type the following on the command line:
./example6 ex6_output.txt
The result is ex6_output.txt
Example 7: Print out the non-zero elements of a row or column of a matrix.
wn_matrix routines demonstrated in example7.c are:
- Line 86: WnMatrix__new()
- Line 95: WnMatrix__assignElement()
- Line 120: WnMatrix__getRow()
- Line 125: WnMatrix__getColumn()
- Line 135: WnMatrix__Line__getNonZeroIndices()
- Line 136: WnMatrix__Line__getNonZeroElements()
- Line 138: WnMatrix__Line__getNumberOfElements()
- Line 150: WnMatrix__Line__free()
- Line 151: WnMatrix__free()
To run example7, type the following on the command line:
./example7 ../../data_pub/coordinate_matrix_1_input.txt row 1 > ex7_output.txt
The result is ex7_output.txt
Try other rows or columns. For example, try
./example7 ../../data_pub/coordinate_matrix_1_input.txt column 2 > ex7_output_column.txt
The result is ex7_output_column.txt
Example 8: Get the transfer matrix form of a matrix.
wn_matrix routines demonstrated in example8.c are:
- Line 91: WnMatrix__new()
- Line 100: WnMatrix__assignElement()
- Line 113: WnMatrix__getTransferMatrix()
- Line 123: WnMatrix__getNumberOfRows()
- Line 126: WnMatrix__getNumberOfColumns()
- Line 133: WnMatrix__getElement()
- Line 146: WnMatrix__free()
To run example8, type the following on the command line:
./example8 ../../data_pub/coordinate_matrix_2_input.txt ex8_output.txt
The result is ex8_output.txt
Example 9: Get a copy of a matrix and the transpose of a matrix.
wn_matrix routines demonstrated in example9.c are:
- Line 92: WnMatrix__new()
- Line 101: WnMatrix__assignElement()
- Line 114: WnMatrix__getCopy()
- Line 120: WnMatrix__getTranspose()
- Line 130: WnMatrix__getNumberOfRows()
- Line 133: WnMatrix__getNumberOfColumns()
- Line 140: WnMatrix__getElement()
- Line 155: WnMatrix__free()
To run example9, type the following on the command line:
./example9 ../../data_pub/coordinate_matrix_2_input.txt ex9_output.txt
The result is ex9_output.txt
Example 10: Convert ascii coordinate matrix data into XML data and write to a file.
wn_matrix routines demonstrated in example10.c are:
- Line 82: WnMatrix__new()
- Line 91: WnMatrix__assignElement()
- Line 104: WnMatrix__getCoo()
- Line 110: WnMatrix__free()
- Line 116: WnMatrix__Coo__writeToXmlFile()
- Line 122: WnMatrix__Coo__free()
To run example10, type the following on the command line:
./example10 ../../data_pub/coordinate_matrix_2_input.txt ex10_output.xml
The result is ex10_output.xml
Example 11: Print out the data from a matrix in XML format.
wn_matrix routines demonstrated in example11.c are:
- Line 53: WnMatrix__is_valid_input_xml()
- Line 63: WnMatrix__new_from_xml()
- Line 72: WnMatrix__getCoo()
- Line 81: WnMatrix__getNumberOfElements()
- Line 86: WnMatrix__Coo__getRowVector()
- Line 87: WnMatrix__Coo__getColumnVector()
- Line 88: WnMatrix__Coo__getValueVector()
- Line 97: WnMatrix__Coo__free()
- Line 99: WnMatrix__free()
To run example11, type the following on the command line:
./example11 ../../data_pub/coordinate_matrix_2.xml > ex11_output.txt
The result is ex11_output.txt
Use an XPath expression to select out particular rows, columns, or values:
./example11 ../../data_pub/coordinate_matrix_2.xml "[row < 3 or value > 0]" > ex11_output_xpath.txt
The result is ex11_output_xpath.txt
Example 12: Read in coordinate matrix data from an XML file, convert to compressed sparse row format, and output to an XML file.
wn_matrix routines demonstrated in example12.c are:
- Line 53: WnMatrix__is_valid_input_xml()
- Line 62: WnMatrix__new_from_xml()
- Line 68: WnMatrix__getCsr()
- Line 74: WnMatrix__free()
- Line 80: WnMatrix__Csr__writeToXmlFile()
- Line 86: WnMatrix__Csr__free()
To run example12, type the following on the command line:
./example12 ../../data_pub/coordinate_matrix_2.xml ex12_csr.xml
The result is ex12_csr.xml
Example 13: Read in coordinate matrix data from an XML file, convert to Yale sparse format, and output to an XML file.
wn_matrix routines demonstrated in example13.c are:
- Line 53: WnMatrix__is_valid_input_xml()
- Line 62: WnMatrix__new_from_xml()
- Line 68: WnMatrix__getYale()
- Line 74: WnMatrix__free()
- Line 80: WnMatrix__Yale__writeToXmlFile()
- Line 86: WnMatrix__Yale__free()
To run example13, type the following on the command line:
./example13 ../../data_pub/coordinate_matrix_2.xml ex13_yale.xml
The result is ex13_yale.xml
