rindow/rindow-matlib-ffi

The math matrix library for FFI on PHP

1.0.2 2024-04-25 14:59 UTC

Requires

• php: ^8.1
• interop-phpobjects/polite-math: ~1.0.7

Requires (Dev)

• ext-ffi: *
• rindow/rindow-math-buffer-ffi: ^1.0

BSD-3-Clause

• math
• matrix
• ffi
• rindow

README

Status:

"The interface of rindow matlib on ffi".

Please see the documents about rindow mathematics on Rindow Mathematics web pages.

You can call a high-speed calculation library written in C language to speed up matrix calculation processing. Rindow Matlib includes many matrix operations functions used in machine learning.

Requirements

• PHP 8.1 or PHP8.2 or PHP8.3
• Rindow Matlib C Library(Windows 10 or Linux(Ubuntu 20.04 or Debian 12) or later)

How to setup

How to setup for Windows

Download the pre-build binary file.

• https://github.com/rindow/rindow-matlib/releases

Unzip the file for Windows and copy rindowmatlib.dll to the directory set in PATH.

C> copy rindowmatlib.dll C:\php
C> PATH %PATH%;C:\php

Set it up using composer.

C> mkdir \your\app\dir
C> cd \your\app\dir
C> composer require rindow/rindow-matlib-ffi

How to setup for Linux

Download the pre-build binary file.

• https://github.com/rindow/rindow-matlib/releases

Please install using the apt command.

$ sudo apt install ./rindow-matlib_X.X.X_amd64.deb

Set it up using composer.

$ mkdir \your\app\dir
$ cd \your\app\dir
$ composer require rindow/rindow-matlib-ffi

Troubleshooting for Linux

Since rindow-matlib currently uses OpenMP, choose the OpenMP version for OpenBLAS as well.

Using the pthread version of OpenBLAS can cause conflicts and become unstable and slow. This issue does not occur on Windows.

If you have already installed the pthread version of OpenBLAS,

$ sudo apt install libopenblas0-openmp liblapacke
$ sudo apt remove libopenblas0-pthread

But if you can't remove it, you can switch to it using the update-alternatives command.

$ sudo update-alternatives --config libopenblas.so.0-x86_64-linux-gnu
$ sudo update-alternatives --config liblapack.so.3-x86_64-linux-gnu

If you really want to use the pthread version of OpenBLAS, please switch to the serial version of rindow-matlib.

There are no operational mode conflicts with OpenBLAS on Windows.

But, If you really want to use the pthread version of OpenBLAS, please switch to the serial version of rindow-matlib.

$ sudo update-alternatives --config librindowmatlib.so
There are 2 choices for the alternative librindowmatlib.so (providing /usr/lib/librindowmatlib.so).

  Selection    Path                                             Priority   Status
------------------------------------------------------------
* 0            /usr/lib/rindowmatlib-openmp/librindowmatlib.so   95        auto mode
  1            /usr/lib/rindowmatlib-openmp/librindowmatlib.so   95        manual mode
  2            /usr/lib/rindowmatlib-serial/librindowmatlib.so   90        manual mode

Press <enter> to keep the current choice[*], or type selection number: 2

Choose the "rindowmatlib-serial".

How to use

$ composer require rindow/rindow-matlib-ffi
$ composer require rindow/rindow-math-buffer-ffi

<?php
include __DIR__.'/vendor/autoload.php';

use Interop\Polite\Math\Matrix\NDArray;
use Rindow\Matlib\FFI\MatlibFactory;
use Rindow\Math\Buffer\FFI\BufferFactory;

$factory = new MatlibFactory();
$math = $factory->Math();
$hostBufferFactory = new BufferFactory();
$NWITEMS = 64;

$x = $hostBufferFactory->Buffer(
    $NWITEMS,NDArray::float32
);

for($i=0;$i<$NWITEMS;$i++) {
    $x[$i] = $i;
}
$n = count($x);
$offsetX = 0;
$incX = 1;

$sum = $math->sum($n,$x,$offsetX,$incX);

var_dump($sum);