12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349 |
- <?php
- namespace MathPHP\Tests\Statistics;
- use MathPHP\LinearAlgebra\NumericMatrix;
- use MathPHP\Statistics\Distance;
- use MathPHP\Exception;
- class DistanceTest extends \PHPUnit\Framework\TestCase
- {
- /**
- * @test bhattacharyya
- * @dataProvider dataProviderForBhattacharyyaDistance
- * @param array $p
- * @param array $q
- * @param float $expected
- */
- public function testBhattacharyyaDistance(array $p, array $q, float $expected)
- {
- // When
- $BD = Distance::bhattacharyya($p, $q);
- // Then
- $this->assertEqualsWithDelta($expected, $BD, 0.0001);
- }
- /**
- * @return array [p, q, distance]
- */
- public function dataProviderForBhattacharyyaDistance(): array
- {
- return [
- [
- [0.2, 0.5, 0.3],
- [0.1, 0.4, 0.5],
- 0.024361049046679,
- ],
- [
- [0.4, 0.6],
- [0.3, 0.7],
- 0.005531036666445
- ],
- [
- [0.9, 0.1],
- [0.1, 0.9],
- 0.510825623765991
- ],
- ];
- }
- /**
- * @test bhattacharyya when arrays are different lengths
- */
- public function testBhattacharyyaDistanceExceptionArraysDifferentLength()
- {
- // Given
- $p = [0.4, 0.5, 0.1];
- $q = [0.2, 0.8];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::bhattacharyya($p, $q);
- }
- /**
- * @test bhattacharyya when probabilities do not add up to one
- */
- public function testBhattacharyyaDistanceExceptionNotProbabilityDistributionThatAddsUpToOne()
- {
- // Given
- $p = [0.2, 0.2, 0.1];
- $q = [0.2, 0.4, 0.6];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::bhattacharyya($p, $q);
- }
- /**
- * @test hellinger
- * @dataProvider dataProviderForHellingerDistance
- * @param array $p
- * @param array $q
- * @param float $expected
- */
- public function testHellingerDistance(array $p, array $q, float $expected)
- {
- // When
- $BD = Distance::hellinger($p, $q);
- // Then
- $this->assertEqualsWithDelta($expected, $BD, 0.0001);
- }
- /**
- * Test data created with Python's numpy/scipy: norm(np.sqrt(p) - np.sqrt(q)) / np.sqrt(2)
- * @return array [p, q, distance]
- */
- public function dataProviderForHellingerDistance(): array
- {
- return [
- [
- [0.2905, 0.4861, 0.2234],
- [0.2704, 0.5259, 0.2137],
- 0.025008343695279284,
- ],
- [
- [0.5, 0.5],
- [0.75, 0.25],
- 0.18459191128251448,
- ],
- [
- [0.2, 0.5, 0.3],
- [0.1, 0.4, 0.5],
- 0.15513450177826621,
- ],
- [
- [0.4, 0.6],
- [0.3, 0.7],
- 0.074268220965891737
- ],
- [
- [0.9, 0.1],
- [0.1, 0.9],
- 0.63245553203367577
- ],
- ];
- }
- /**
- * @test hellinger when the arrays are different lengths
- */
- public function testHellingerDistanceExceptionArraysDifferentLength()
- {
- // Given
- $p = [0.4, 0.5, 0.1];
- $q = [0.2, 0.8];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::hellinger($p, $q);
- }
- /**
- * @test hellinger when the probabilities do not add up to one
- */
- public function testHellingerDistanceExceptionNotProbabilityDistributionThatAddsUpToOne()
- {
- // Given
- $p = [0.2, 0.2, 0.1];
- $q = [0.2, 0.4, 0.6];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::hellinger($p, $q);
- }
- /**
- * @test jensenShannon
- * @dataProvider dataProviderForJensenShannon
- * @param array $p
- * @param array $q
- * @param float $expected
- */
- public function testJensenShannon(array $p, array $q, float $expected)
- {
- // When
- $BD = Distance::jensenShannon($p, $q);
- // Then
- $this->assertEqualsWithDelta($expected, $BD, 0.0001);
- }
- /**
- * Test data created with Python scipy.spatial.distance.jensenshannon
- * distance.jensenshannon(p, q)
- * @return array [p, q, distance]
- */
- public function dataProviderForJensenShannon(): array
- {
- return [
- [
- [0.4, 0.6],
- [0.5, 0.5],
- 0.07112938864483229,
- ],
- [
- [0.1, 0.2, 0.2, 0.2, 0.2, 0.1],
- [0.0, 0.1, 0.4, 0.4, 0.1, 0.0],
- 0.346820456568833
- ],
- [
- [0.25, 0.5, 0.25],
- [0.5, 0.3, 0.2],
- 0.18778369857844396,
- ],
- [
- [0.5, 0.3, 0.2],
- [0.25, 0.5, 0.25],
- 0.18778369857844396,
- ],
- ];
- }
- /**
- * @test jensenShannon when the arrays are different lengths
- */
- public function testJensenShannonExceptionArraysDifferentLength()
- {
- // Given
- $p = [0.4, 0.5, 0.1];
- $q = [0.2, 0.8];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::jensenShannon($p, $q);
- }
- /**
- * @test jensenShannon when the probabilities do not add up to one
- */
- public function testJensenShannonExceptionNotProbabilityDistributionThatAddsUpToOne()
- {
- // Given
- $p = [0.2, 0.2, 0.1];
- $q = [0.2, 0.4, 0.6];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::jensenShannon($p, $q);
- }
- /**
- * @test Mahalanobis from a point to the center of the data
- * @dataProvider dataProviderForMahalanobisCenter
- * @param array $x
- * @param NumericMatrix $data
- * @param float $expectedDistance
- * @throws \Exception
- */
- public function testMahalanobisCenter(array $x, NumericMatrix $data, float $expectedDistance)
- {
- // Given
- $x_m = new NumericMatrix($x);
- // When
- $distance = Distance::mahalanobis($x_m, $data);
- // Then
- $this->assertEqualsWithDelta($expectedDistance, $distance, 0.0001);
- }
- /**
- * @return array [x, data, distance]
- * @throws \Exception
- */
- public function dataProviderForMahalanobisCenter(): array
- {
- $data = [
- [4, 4, 5, 2, 3, 6, 9, 7, 4, 5],
- [3, 7, 5, 7, 9, 5, 6, 2, 2, 7],
- ];
- $data_matrix = new NumericMatrix($data);
- return [
- [
- [[4], [3]],
- $data_matrix,
- 1.24017
- ],
- [
- [[4], [7]],
- $data_matrix,
- 0.76023
- ],
- [
- [[5], [5]],
- $data_matrix,
- 0.12775
- ],
- [
- [[2], [7]],
- $data_matrix,
- 1.46567
- ],
- [
- [[3], [9]],
- $data_matrix,
- 1.64518
- ],
- ];
- }
- /**
- * @test Mahalanobis between two points
- * @dataProvider dataProviderForMahalanobisPoint
- * @param array $x
- * @param array $y
- * @param NumericMatrix $data
- * @param float $expectedDistance
- * @throws \Exception
- */
- public function testMahalanobisPoint(array $x, array $y, NumericMatrix $data, float $expectedDistance)
- {
- // Given
- $x_m = new NumericMatrix($x);
- $y_m = new NumericMatrix($y);
- // when
- $distance = Distance::mahalanobis($x_m, $data, $y_m);
- // Then
- $this->assertEqualsWithDelta($expectedDistance, $distance, 0.0001);
- }
- /**
- * @return array [x, y, data, distance]
- * @throws \Exception
- */
- public function dataProviderForMahalanobisPoint(): array
- {
- $data = [
- [4, 4, 5, 2, 3, 6, 9, 7, 4, 5],
- [3, 7, 5, 7, 9, 5, 6, 2, 2, 7],
- ];
- $data_matrix = new NumericMatrix($data);
- return [
- [
- [[6], [5]],
- [[2], [2]],
- $data_matrix,
- 2.76992
- ],
- [
- [[9], [6]],
- [[2], [2]],
- $data_matrix,
- 4.47614
- ],
- [
- [[7], [2]],
- [[2], [2]],
- $data_matrix,
- 2.58465
- ],
- [
- [[4], [2]],
- [[2], [2]],
- $data_matrix,
- 1.03386
- ],
- [
- [[5], [7]],
- [[2], [-2]],
- $data_matrix,
- 4.6909
- ],
- ];
- }
- /**
- * @test Mahalanobis between two datasets
- * https://rdrr.io/rforge/GenAlgo/man/maha.html
- * @throws \Exception
- */
- public function testMahalanobisTwoData()
- {
- // Given
- $data1 = new NumericMatrix([
- [4, 4, 5, 2, 3, 6, 9, 7, 4, 5],
- [3, 7, 5, 7, 9, 5, 6, 2, 2, 7],
- ]);
- $data2 = new NumericMatrix([
- [5, 3, 6, 3, 9],
- [7, 6, 1, 2, 9],
- ]);
- // When
- $distance = Distance::mahalanobis($data2, $data1);
- // Then
- $this->assertEqualsWithDelta(0.1863069, $distance, 0.0001);
- }
- /**
- * @test Minkowski distance
- * @dataProvider dataProviderForMinkowskiDistance
- * @param float[] $x
- * @param float[] $y
- * @param int $p
- * @param float $expected
- */
- public function testMinkowski(array $x, array $y, int $p, float $expected)
- {
- // When
- $distanceXy = Distance::minkowski($x, $y, $p);
- $distanceYx = Distance::minkowski($y, $x, $p);
- // Then
- $this->assertEqualsWithDelta($expected, $distanceXy, 0.0000000001);
- $this->assertEqualsWithDelta($expected, $distanceYx, 0.0000000001);
- }
- /**
- * Test data created using Python: from scipy.spatial import distance
- * distance.minkowski(x, y, p)
- * @return array
- */
- public function dataProviderForMinkowskiDistance(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 1,
- 2,
- ],
- [
- [1, 0, 0],
- [0, 1, 0],
- 2,
- 1.4142135623730951,
- ],
- [
- [1, 0, 0],
- [0, 1, 0],
- 3,
- 1.2599210498948732,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 1,
- 1,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 2,
- 1,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 3,
- 1,
- ],
- [
- [1, 2, 3],
- [0, 0, 0],
- 1,
- 6,
- ],
- [
- [1, 2, 3],
- [0, 0, 0],
- 2,
- 3.7416573867739413,
- ],
- [
- [1, 2, 3],
- [0, 0, 0],
- 3,
- 3.3019272488946263,
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- 1,
- 0,
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- 2,
- 0,
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- 3,
- 0,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 1,
- 0,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 2,
- 0,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 3,
- 0,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 1,
- 113,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 2,
- 72.83543093852057,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 3,
- 64.51064463863402,
- ],
- ];
- }
- /**
- * @test minkowski error when vectors are of different sizes
- */
- public function testMinkowskiErrorDifferentSizedVectors()
- {
- // Given
- $x = [1, 2, 3];
- $y = [1, 2];
- $irrelevantValueForP = 1;
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::minkowski($x, $y, $irrelevantValueForP);
- }
- /**
- * @test minkowski error p value is < 1
- */
- public function testMinkowskiErrorPLessThanOne()
- {
- // Given
- $x = [1, 2, 3];
- $y = [1, 2, 3];
- $p = 0;
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::minkowski($x, $y, $p);
- }
- /**
- * @test Euclidean distance
- * @dataProvider dataProviderForEuclideanDistance
- * @param float[] $x
- * @param float[] $y
- * @param float $expected
- */
- public function testEuclidean(array $x, array $y, float $expected)
- {
- // When
- $distance = Distance::euclidean($x, $y);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0000000001);
- }
- /**
- * Test data created using Python: from scipy.spatial import distance
- * distance.euclidean(x, y)
- * @return array
- */
- public function dataProviderForEuclideanDistance(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 1.4142135623730951,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [1, 2, 3],
- [0, 0, 0],
- 3.7416573867739413,
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- 0,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 0,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 72.83543093852057,
- ],
- ];
- }
- /**
- * @test euclidean error when vectors are of different sizes
- */
- public function testEuclideanErrorDifferentSizedVectors()
- {
- // Given
- $x = [1, 2, 3];
- $y = [1, 2];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::euclidean($x, $y);
- }
- /**
- * @test Manhattan distance
- * @dataProvider dataProviderForManhattanDistance
- * @param float[] $x
- * @param float[] $y
- * @param float $expected
- */
- public function testManhattan(array $x, array $y, float $expected)
- {
- // When
- $distance = Distance::manhattan($x, $y);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0000000001);
- }
- /**
- * Test data created using Python: from scipy.spatial import distance
- * distance.minkowski(x, y, 1)
- * @return array
- */
- public function dataProviderForManhattanDistance(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 2,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [1, 2, 3],
- [0, 0, 0],
- 6,
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- 0,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 0,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 113,
- ],
- ];
- }
- /**
- * @test manhattan error when vectors are of different sizes
- */
- public function testManhattanErrorDifferentSizedVectors()
- {
- // Given
- $x = [1, 2, 3];
- $y = [1, 2];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::manhattan($x, $y);
- }
- /**
- * @test cosine distance
- * @dataProvider dataProviderForCosineDistance
- * @param array $A
- * @param array $B
- * @param float $expected
- */
- public function testCosineDistance(array $A, array $B, float $expected)
- {
- // When
- $distance = Distance::cosine($A, $B);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0000000001);
- }
- /**
- * Test data created using Python: from scipy.spatial import distance
- * distance.cosine(x, y)
- * @return array
- */
- public function dataProviderForCosineDistance(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [100, 0, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 0.29289321881345254,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 0,
- ],
- [
- [2, 2, 2],
- [2, 2, 2],
- 0,
- ],
- [
- [1, 1, 1],
- [2, 2, 2],
- 0,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 0.1840657409250167,
- ],
- ];
- }
- /**
- * @test cosine distance exception for null vector
- * @dataProvider dataProviderForCosineDistanceException
- * @param array $A
- * @param array $B
- */
- public function testCosineDistanceException(array $A, array $B)
- {
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::cosine($A, $B);
- }
- /**
- * @return array
- */
- public function dataProviderForCosineDistanceException(): array
- {
- return [
- [
- [1, 2, 3],
- [0, 0, 0],
- ],
- [
- [0, 0, 0],
- [1, 2, 3],
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- ],
- ];
- }
- /**
- * @test cosineSimilarity
- * @dataProvider dataProviderForCosineSimilarity
- * @param array $A
- * @param array $B
- * @param float $expected
- */
- public function testCosineSimilarity(array $A, array $B, float $expected)
- {
- // When
- $distance = Distance::cosineSimilarity($A, $B);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0000000001);
- }
- /**
- * Test data created using Python: from scipy.spatial import distance
- * 1 - distance.cosine(x, y)
- * Cross referenced with online calculator: https://www.emathhelp.net/calculators/linear-algebra/angle-between-two-vectors-calculator
- * @return array
- */
- public function dataProviderForCosineSimilarity(): array
- {
- return [
- [
- [1, 2, 3],
- [3, 2, 1],
- 0.7142857142857143,
- ],
- [
- [1, 0, 0],
- [0, 1, 0],
- 0,
- ],
- [
- [1, 0, 0],
- [0, 0, 1],
- 0,
- ],
- [
- [1, 0, 0],
- [1, 0, 0],
- 1,
- ],
- [
- [100, 0, 0],
- [0, 1, 0],
- 0,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 0.7071067811865475,
- ],
- [
- [1, 1, 1],
- [1, 1, 1],
- 1,
- ],
- [
- [2, 2, 2],
- [2, 2, 2],
- 1,
- ],
- [
- [1, 1, 1],
- [2, 2, 2],
- 1,
- ],
- [
- [56, 26, 83],
- [11, 82, 95],
- 0.8159342590749833,
- ],
- [
- [-1, 1, 0],
- [0, 1, -1],
- 0.5,
- ],
- [
- [23, 41, 33],
- [31, 56, 21],
- 0.9567820320723087,
- ],
- ];
- }
- /**
- * @test cosineSimilarity exception for null vector
- * @dataProvider dataProviderForCosineSimilarityException
- * @param array $A
- * @param array $B
- */
- public function testCosineSimilarityException(array $A, array $B)
- {
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::cosineSimilarity($A, $B);
- }
- /**
- * @return array
- */
- public function dataProviderForCosineSimilarityException(): array
- {
- return [
- [
- [1, 2, 3],
- [0, 0, 0],
- ],
- [
- [0, 0, 0],
- [1, 2, 3],
- ],
- [
- [0, 0, 0],
- [0, 0, 0],
- ],
- ];
- }
- /**
- * @test brayCurtis
- * @dataProvider dataProviderForBrayCurtis
- * @param array $u
- * @param array $v
- * @param float $expected
- */
- public function testBrayCurtis(array $u, array $v, float $expected)
- {
- // When
- $distance = Distance::brayCurtis($u, $v);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0001);
- }
- /**
- * Test data created with Python scipy.spatial.distance.braycurtis
- * distance.braycurtis(u, v)
- * @return array [u, v, distance]
- */
- public function dataProviderForBrayCurtis(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 0.33333333333333331,
- ],
- [
- [1, 2, 3],
- [1, 2, 3],
- 0,
- ],
- [
- [1, 2, 3],
- [3, 2, 1],
- 0.3333333333333333,
- ],
- [
- [0.4, 0.6],
- [0.5, 0.5],
- 0.09999999999999998,
- ],
- [
- [0.1, 0.2, 0.2, 0.2, 0.2, 0.1],
- [0.0, 0.1, 0.4, 0.4, 0.1, 0.0],
- 0.4
- ],
- [
- [0.25, 0.5, 0.25],
- [0.5, 0.3, 0.2],
- 0.25,
- ],
- [
- [0.5, 0.3, 0.2],
- [0.25, 0.5, 0.25],
- 0.25,
- ],
- [
- [1],
- [0],
- 1,
- ],
- [
- [0],
- [1],
- 1,
- ],
- [
- [1],
- [1],
- 0,
- ],
- [
- [-1],
- [-1],
- 0,
- ],
- [
- [-2],
- [-3],
- 0.2,
- ],
- ];
- }
- /**
- * @test brayCurtis NAN
- * @dataProvider dataProviderForBrayCurtisNan
- * @param array $u
- * @param array $v
- */
- public function testBrayCurtisNan(array $u, array $v)
- {
- // When
- $distance = Distance::brayCurtis($u, $v);
- // Then
- $this->assertNan($distance);
- }
- /**
- * @return array
- */
- public function dataProviderForBrayCurtisNan(): array
- {
- return [
- 'both zero ' => [
- [0],
- [0],
- ],
- '∑|uᵢ + vᵢ| denominator is zero (1)' => [
- [1],
- [-1],
- ],
- '∑|uᵢ + vᵢ| demoninator is zero (2)' => [
- [1, 2],
- [-1, -2],
- ],
- ];
- }
- /**
- * @test brayCurtis exception when inputs are different lengths
- * @throws Exception\BadDataException
- */
- public function testBrayCurtisExceptionDifferentNumberElements()
- {
- // Given
- $u = [1, 2, 3];
- $v = [2, 3];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::brayCurtis($u, $v);
- }
- /**
- * @test canberra
- * @dataProvider dataProviderForCanberra
- * @param array $p
- * @param array $q
- * @param float $expected
- */
- public function testCanberra(array $p, array $q, float $expected)
- {
- // When
- $distance = Distance::canberra($p, $q);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0001);
- }
- /**
- * Test data created with Python scipy.spatial.distance.canberra
- * distance.canberra(p, q)
- * @return array [p, q, distance]
- */
- public function dataProviderForCanberra(): array
- {
- return [
- [
- [1, 0, 0],
- [0, 1, 0],
- 2,
- ],
- [
- [1, 1, 0],
- [0, 1, 0],
- 1,
- ],
- [
- [1, 2, 3],
- [1, 2, 3],
- 0,
- ],
- [
- [1, 2, 3],
- [3, 2, 1],
- 1,
- ],
- [
- [0.4, 0.6],
- [0.5, 0.5],
- 0.20202020202020196,
- ],
- [
- [0.1, 0.2, 0.2, 0.2, 0.2, 0.1],
- [0.0, 0.1, 0.4, 0.4, 0.1, 0.0],
- 3.333333333333333
- ],
- [
- [0.25, 0.5, 0.25],
- [0.5, 0.3, 0.2],
- 0.6944444444444443,
- ],
- [
- [0.5, 0.3, 0.2],
- [0.25, 0.5, 0.25],
- 0.6944444444444443,
- ],
- [
- [1],
- [0],
- 1,
- ],
- [
- [0],
- [1],
- 1,
- ],
- [
- [1],
- [1],
- 0,
- ],
- [
- [-1],
- [-1],
- 0,
- ],
- [
- [-2],
- [-3],
- 0.2,
- ],
- [
- [1, 1, 1],
- [1, 1, 0],
- 1,
- ],
- [
- [1, 1, 0],
- [1, 1, 1],
- 1,
- ],
- [
- [1, 1, 1],
- [10, 5, 0],
- 2.484848484848485,
- ],
- [
- [10, 5, 0],
- [1, 1, 1],
- 2.484848484848485,
- ],
- [
- [10, 10, 10],
- [11, 11, 11],
- 0.14285714285714285,
- ],
- [
- [11, 11, 11],
- [10, 10, 10],
- 0.14285714285714285,
- ],
- ];
- }
- /**
- * @test canberra NAN
- * @dataProvider dataProviderForCanberraNan
- * @param array $u
- * @param array $v
- */
- public function testCanberraNan(array $u, array $v)
- {
- // When
- $distance = Distance::canberra($u, $v);
- // Then
- $this->assertNan($distance);
- }
- /**
- * @return array
- */
- public function dataProviderForCanberraNan(): array
- {
- return [
- 'both zero ' => [
- [0],
- [0],
- ],
- 'all zeros' => [
- [0, 0, 0],
- [0, 0, 0],
- ],
- ];
- }
- /**
- * @test canberra exception when inputs are different lengths
- * @throws Exception\BadDataException
- */
- public function testCanberraExceptionDifferentNumberElements()
- {
- // Given
- $p = [1, 2, 3];
- $q = [2, 3];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- $distance = Distance::canberra($p, $q);
- }
- /**
- * @test chebyshev
- * @dataProvider dataProviderForChebyshev
- * @param array $x
- * @param array $y
- * @param float $expected
- */
- public function testChebyshev(array $x, array $y, float $expected): void
- {
- // When
- $distance = Distance::chebyshev($x, $y);
- // Then
- $this->assertEqualsWithDelta($expected, $distance, 0.0001);
- }
- public function dataProviderForChebyshev(): array
- {
- return [
- [
- [0],
- [0],
- 0
- ],
- [
- [1],
- [1],
- 0
- ],
- [
- [1],
- [0],
- 1
- ],
- [
- [0],
- [1],
- 1
- ],
- [
- [1, 2],
- [2, 4],
- 2
- ],
- [
- [1, 2, 3],
- [2, 4, 6],
- 3
- ],
- [
- [0, 3, 4, 5],
- [7, 6, 3, -1],
- 7
- ],
- [
- [1, 2, 3, 4],
- [-5, -6, 7, 8],
- 8
- ],
- [
- [1, 5, 2, 3, 10],
- [4, 15, 20, 5, 5],
- 18
- ],
- [
- [1, 5, 2, 3, 10],
- [1, 5, 2, 3, 10],
- 0
- ],
- [
- [4, 15, 20, 5, 5],
- [4, 15, 20, 5, 5],
- 0
- ],
- ];
- }
- /**
- * @test chebyshev exception when inputs are different lengths
- * @throws Exception\BadDataException
- */
- public function testChebyshevExceptionDifferentNumberElements()
- {
- // Given
- $xs = [1, 2, 3];
- $ys = [2, 3];
- // Then
- $this->expectException(Exception\BadDataException::class);
- // When
- Distance::chebyshev($xs, $ys);
- }
- }
|