olcaytaner/math

Math Library

1.0.0 2024-12-28 14:52 UTC

Requires (Dev)

• phpunit/phpunit: 11.4.0

GPL-3.0-or-later

• y

README

For Developers

You can also see Java, Python, Js, Cython, Swift, C++, C, or C# repository.

Requirements

• Php 8.0 or higher
• Git

Php

To check if you have a compatible version of Php installed, use the following command:

php -V

You can find the latest version of Php here.

Git

Install the latest version of Git.

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called DataStructure will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/Math-Php.git

Open project with PhpStorm IDE

Steps for opening the cloned project:

• Start IDE
• Select File | Open from main menu
• Choose Math-Php file
• Select open as project option
• Couple of seconds, dependencies will be downloaded.

Detailed Description

• Vector
• Matrix
• Distribution

Vector

Bir vektör yaratmak için:

__construct(mixed $valuesOrSize = null, mixed $initial = null, mixed $index = null)

Vektörler eklemek için

addVector(Vector $v): void

Çıkarmak için

subtract(Vector $v): void
difference(Vector $v): Vector

İç çarpım için

dotProduct(Vector $v): float
dotProductWithItself(): float

Bir vektörle cosinüs benzerliğini hesaplamak için

cosineSimilarity(Vector $v): float

Bir vektörle eleman eleman çarpmak için

elementProduct(Vector $v): Vector

Matrix

3'e 4'lük bir matris yaratmak için

$a = new Matrix(3, 4)

Elemanları rasgele değerler alan bir matris yaratmak için

__construct(mixed $row, mixed $col = null, mixed $minValue = null, mixed $maxValue = null)

Örneğin,

$a = new Matrix(3, 4, 1, 5)

3'e 4'lük elemanları 1 ve 5 arasında değerler alan bir matris yaratır.

Matrisin i. satır, j. sütun elemanını getirmek için

getValue(int $rowNo, int $colNo): float

Örneğin,

$a->getValue(3, 4)

1. satır, 4. sütundaki değeri getirir.

Matrisin i. satır, j. sütunundaki elemanı değiştirmek için

setValue(int $rowNo, int $colNo, float $value): void

Örneğin,

$a->setValue(3, 4, 5)

1. satır, 4.sütundaki elemanın değerini 5 yapar.

Matrisleri toplamak için

add(Matrix|int $m, Vector $v = null): void

Çıkarmak için

subtract(Matrix $m): void

Çarpmak için

multiply(Matrix $m): Matrix

Elaman eleman matrisleri çarpmak için

elementProduct(Matrix|Vector $m): Matrix

Matrisin transpozunu almak için

transpose(): Matrix

Matrisin simetrik olup olmadığı belirlemek için

isSymmetric(): bool

Determinantını almak için

determinant(): float

Tersini almak için

inverse(): void

Matrisin eigenvektör ve eigendeğerlerini bulmak için

characteristics(): array

Bu metodla bulunan eigenvektörler eigendeğerlerine göre büyükten küçüğe doğru sıralı olarak döndürülür.

Distribution

Verilen bir değerin normal dağılımdaki olasılığını döndürmek için

zNormal(float $z): float

Verilen bir olasılığın normal dağılımdaki değerini döndürmek için

zInverse(float $p): float

Verilen bir değerin chi kare dağılımdaki olasılığını döndürmek için

chiSquare(float $x, int $freedom): float

Verilen bir olasılığın chi kare dağılımdaki değerini döndürmek için

chiSquareInverse(float $p, int $freedom): float

Verilen bir değerin F dağılımdaki olasılığını döndürmek için

fDistribution(float $F, int $freedom1, int $freedom2): float

Verilen bir olasılığın F dağılımdaki değerini döndürmek için

fDistributionInverse(float $p, int $freedom1, int $freedom2): float

Verilen bir değerin t dağılımdaki olasılığını döndürmek için

tDistribution(float $T, int $freedom): float

Verilen bir olasılığın t dağılımdaki değerini döndürmek için

tDistributionInverse(float $p, int $freedom): float

For Contibutors

composer.json file

1. autoload is important when this package will be imported.

  "autoload": {
    "psr-4": {
      "olcaytaner\\WordNet\\": "src/"
    }
  },

1. Dependencies should be maximum (not only direct but also indirect references should also be given), everything directly in the code should be given here.

  "require-dev": {
    "phpunit/phpunit": "11.4.0",
    "olcaytaner/dictionary": "1.0.0",
    "olcaytaner/xmlparser": "1.0.1",
    "olcaytaner/morphologicalanalysis": "1.0.0"
  }

Data files

1. Add data files to the project folder. Subprojects should include all data files of the parent projects.

Php files

1. Do not forget to comment each function.

    /**
     * Returns true if specified semantic relation type presents in the relations list.
     *
     * @param SemanticRelationType $relationType element whose presence in the list is to be tested
     * @return bool true if specified semantic relation type presents in the relations list
     */
    public function containsRelationType(SemanticRelationType $relationType): bool{
        foreach ($this->relations as $relation){
            if ($relation instanceof SematicRelation && $relation->getRelationType() == $relationType){
                return true;
            }
        }
        return false;
    }

1. Function names should follow caml case.

    public function getRelation(int $index): Relation{

1. Write getter and setter methods.

    public function getOrigin(): ?string
    public function setName(string $name): void

1. Use standard javascript test style by extending the TestCase class. Use setup when necessary.

class WordNetTest extends TestCase
{
    private WordNet $turkish;

    protected function setUp(): void
    {
        ini_set('memory_limit', '450M');
        $this->turkish = new WordNet();
    }

    public function testSize()
    {
        $this->assertEquals(78327, $this->turkish->size());
    }

1. Enumerated types should be declared with enum.

enum CategoryType
{
    case MATHEMATICS;
    case SPORT;
    case MUSIC;
    case SLANG;
    case BOTANIC;

1. If there are multiple constructors for a class, define them as constructor1, constructor2, ..., then from the original constructor call these methods.

    public function constructor1(string $path, string $fileName): void
    public function constructor2(string $path, string $extension, int $index): void
    public function __construct(string $path, string $extension, ?int $index = null)

1. Use __toString method if necessary to create strings from objects.

    public function __toString(): string

1. Use xmlparser package for parsing xml files.

  $doc = new XmlDocument("../test.xml");
  $doc->parse();
  $root = $doc->getFirstChild();
  $firstChild = $root->getFirstChild();