php-armadillo/stubs/internal/Operable.php

<?php

namespace Arma\Internal;

/**
 * Interface for objects which support arithmetic operations.
 *
 * @package Arma\Internal
 */
interface Operable
{
    /**
     * Addition of two objects.
     *
     * @param static $other
     * @return static
     */
    function add($other);

    /**
     * Subtraction of two objects.
     *
     * @param static $other
     * @return static
     */
    function sub($other);

    /**
     * Negation of the object.
     *
     * @return static
     */
    function neg();

    /**
     * Matrix multiplication of two objects.
     *
     * @param static $other
     * @return static
     */
    function mul($other);

    /**
     * Element-wise multiplication of two objects.
     *
     * @param static $other
     * @return static
     */
    function dotMul($other);

    /**
     * Element-wise division of an object by another object or a scalar.
     *
     * @param static|number $other
     * @return static
     */
    function div($other);

    /**
     * Element-wise equality evaluation of two objects.
     *
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function equals($other);

    /**
     * Element-wise non-equality evaluation of two objects.
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function notEquals($other);

    /**
     * Element-wise "greater than" evaluation of two objects.
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function greaterThan($other);

    /**
     * Element-wise "smaller than" evaluation of two objects.
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function smallerThan($other);

    /**
     * Element-wise "not greater than" evaluation of two objects.
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function notGreaterThan($other);

    /**
     * Element-wise "not smaller than" evaluation of two objects.
     *
     * @param static $other
     * @return \Arma\IMat
     */
    function notSmallerThan($other);
}