Skip to content

matlab

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

matlab

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
@sptKruskalTensor
@sptKruskalTensor
 
 
@sptMatrix
@sptMatrix
 
 
@sptSemiSparseTensor
@sptSemiSparseTensor
 
 
@sptSizeVector
@sptSizeVector
 
 
@sptSparseMatrix
@sptSparseMatrix
 
 
@sptSparseTensor
@sptSparseTensor
 
 
@sptVector
@sptVector
 
 
examples
examples
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
sptAppendMatrix.c
sptAppendMatrix.c
 
 
sptAppendSizeVector.c
sptAppendSizeVector.c
 
 
sptAppendVector.c
sptAppendVector.c
 
 
sptConstantMatrix.c
sptConstantMatrix.c
 
 
sptConstantVector.c
sptConstantVector.c
 
 
sptCopyMatrix.c
sptCopyMatrix.c
 
 
sptCopySemiSparseTensor.c
sptCopySemiSparseTensor.c
 
 
sptCopySizeVector.c
sptCopySizeVector.c
 
 
sptCopySparseTensor.c
sptCopySparseTensor.c
 
 
sptCopyVector.c
sptCopyVector.c
 
 
sptCpdAls.c
sptCpdAls.c
 
 
sptCudaCpdAls.c
sptCudaCpdAls.c
 
 
sptCudaMTTKRP.c
sptCudaMTTKRP.c
 
 
sptCudaSparseTensorDotMulEq.c
sptCudaSparseTensorDotMulEq.c
 
 
sptCudaSparseTensorMulMatrix.c
sptCudaSparseTensorMulMatrix.c
 
 
sptDumpKruskalTensor.c
sptDumpKruskalTensor.c
 
 
sptDumpMatrix.c
sptDumpMatrix.c
 
 
sptDumpSizeVector.c
sptDumpSizeVector.c
 
 
sptDumpSparseTensor.c
sptDumpSparseTensor.c
 
 
sptDumpVector.c
sptDumpVector.c
 
 
sptFreeKruskalTensor.c
sptFreeKruskalTensor.c
 
 
sptFreeMatrix.c
sptFreeMatrix.c
 
 
sptFreeSemiSparseTensor.c
sptFreeSemiSparseTensor.c
 
 
sptFreeSizeVector.c
sptFreeSizeVector.c
 
 
sptFreeSparseTensor.c
sptFreeSparseTensor.c
 
 
sptFreeVector.c
sptFreeVector.c
 
 
sptLoadSparseTensor.c
sptLoadSparseTensor.c
 
 
sptMTTKRP.c
sptMTTKRP.c
 
 
sptNewKruskalTensor.c
sptNewKruskalTensor.c
 
 
sptNewMatrix.c
sptNewMatrix.c
 
 
sptNewSemiSparseTensor.c
sptNewSemiSparseTensor.c
 
 
sptNewSizeVector.c
sptNewSizeVector.c
 
 
sptNewSparseTensor.c
sptNewSparseTensor.c
 
 
sptNewVector.c
sptNewVector.c
 
 
sptOmpCpdAls.c
sptOmpCpdAls.c
 
 
sptOmpMTTKRP.c
sptOmpMTTKRP.c
 
 
sptOmpSparseTensorDotMulEq.c
sptOmpSparseTensorDotMulEq.c
 
 
sptOmpSparseTensorMulMatrix.c
sptOmpSparseTensorMulMatrix.c
 
 
sptRandomizeMatrix.c
sptRandomizeMatrix.c
 
 
sptResizeSizeVector.c
sptResizeSizeVector.c
 
 
sptResizeVector.c
sptResizeVector.c
 
 
sptSemiSparseTensorSortIndex.c
sptSemiSparseTensorSortIndex.c
 
 
sptSemiSparseTensorToSparseTensor.c
sptSemiSparseTensorToSparseTensor.c
 
 
sptSparseTensorAdd.c
sptSparseTensorAdd.c
 
 
sptSparseTensorDivScalar.c
sptSparseTensorDivScalar.c
 
 
sptSparseTensorDotDiv.c
sptSparseTensorDotDiv.c
 
 
sptSparseTensorDotMul.c
sptSparseTensorDotMul.c
 
 
sptSparseTensorDotMulEq.c
sptSparseTensorDotMulEq.c
 
 
sptSparseTensorMulMatrix.c
sptSparseTensorMulMatrix.c
 
 
sptSparseTensorMulScalar.c
sptSparseTensorMulScalar.c
 
 
sptSparseTensorSortIndex.c
sptSparseTensorSortIndex.c
 
 
sptSparseTensorSortIndexAtMode.c
sptSparseTensorSortIndexAtMode.c
 
 
sptSparseTensorSub.c
sptSparseTensorSub.c
 
 
sptSparseTensorToMatrix.c
sptSparseTensorToMatrix.c
 
 
sptSparseTensorToSemiSparseTensor.c
sptSparseTensorToSemiSparseTensor.c
 
 
sptmx.h
sptmx.h
 
 

README.md

This directory contains the MATLAB wrapper of ParTI! library.

Building

Type make to build all functions into MEX library.

Running

If libParTI.so is not in the default library search path of your system, you will need to set LD_LIBRARY_PATH to the directory containing libParTI.so before starting MATLAB.

export LD_LIBRARY_PATH=../build:$LD_LIBRARY_PATH
matlab

Interface

This wrapper is a one-to-one mapping of the original C interface.

However there are some differences between C interface and MATLAB interface:

  • Argument mapping

    • Input arguments are mapped into right-hand-side arguments
    • Output arguments are mapped into left-hand-side arguments
    • Bidirectional arguments are placed both left and right
    • Return value is mapped into left-hand-side argument, you will need to allocate a variable to receive this

  • Language convensions

    MATLAB matrices are in FORTRAN style: indices start from 1, memory storage is column major. The MATLAB wrapper for ParTI follows this kind of conversion.

    When you call sptLoadSparseTensor or sptDumpSparseTensor, you can choose the indexing style for your file by specifying a value in start_idx.

  • Data structure exposing

    Data structure is not exposed to MATLAB interface. However you can access the individual fields of each C structure by using the getter/setter functions.

  • Memory safety

    • If the C function requires an initialized data structure, remember to call sptNew* functions to initialize them.
    • If the data structures are not used any longer, remember to call sptFree* functions to finalize them.
    • Be aware of double-freeing: calling sptFree* on the same object twice will crash MATLAB interpreter.

Type conversion

Convert MATLAB 1xN matrix to sptVector:

mxvec = [1 2 3 5 8 13 21];
sptvec = sptNewVector(7, 7);
sptvec.setdata(mxvec);

Then convert it back:

mxvec1 = sptvec.data;
sptFreeVector(sptvec);

Convert MATLAB MxN matrix to sptMatrix:

mxmtx = [1 5 9; 6 7 2; 8 3 4];
sptmtx = sptNewMatrix(3, 3);
sptmtx.setvalues(mxmtx);

Then convert it back:

mxmtx1 = sptmtx.values;
sptFreeMatrix(sptmtx);

Todo

  • Not all functions are wrapped, we are working on this.
  • Error checking and recovering is not fully functional.