Yioop_V9.5_Source_Code_Documentation

BPlusTreeTest extends UnitTest
in package

Yioop B+-tree Unit Class

Used to test insert, lookup, and deletion of key-value pairs on the B+-Tree.

Tags
author

Chris Pollett

Table of Contents

case_name  = "TestCase"
The suffix that all TestCase methods need to have to be called by run()
TEST_DIR  = '/test_files/b_plus_tree_test'
Test directory to hold btree used for these unit tests
$current_method  : string
Contains the value of the next test case to be run can be used by setUp
$table_dirs  : mixed
Folder names to use for test b-trees
$test_case_results  : array<string|int, mixed>
Used to store the results for each test sub case
$test_objects  : array<string|int, mixed>
Used to hold objects to be used in tests
__construct()  : mixed
Constructor should be overridden to do any set up that occurs before and test cases
assertEqual()  : mixed
Checks that $x and $y are the same, the result of the test is added to $this->test_case_results
assertFalse()  : mixed
Checks that $x can coerced to false, the result of the test is added to $this->test_case_results
assertNotEqual()  : mixed
Checks that $x and $y are not the same, the result of the test is added to $this->test_case_results
assertTrue()  : mixed
Checks that $x can coerced to true, the result of the test is added to $this->test_case_results
createTree()  : mixed
Used to create a single hash table in the folder TEST_DIR . $max_items_per_file which allows at most $max_items_per_file to be stored in a bucket
putGetBlobTestCase()  : mixed
Test putting items in bplustrees of odd sized nodes between 3 and 13 and then seeing if the items can be retrieved
putGetTextTestCase()  : mixed
Test putting items in bplustrees of odd sized nodes between 3 and 13 and then seeing if the items can be retrieved
run()  : array<string|int, mixed>
Execute each of the test cases of this unit test and return the results
setUp()  : mixed
Minimum degree is set to 2 and the number of key-value pairs is set to 25
tearDown()  : mixed
Delete the B+-Tree files created during the test

Constants

case_name

The suffix that all TestCase methods need to have to be called by run()

public mixed case_name = "TestCase"

TEST_DIR

Test directory to hold btree used for these unit tests

public mixed TEST_DIR = '/test_files/b_plus_tree_test'

Properties

$current_method

Contains the value of the next test case to be run can be used by setUp

public string $current_method

$table_dirs

Folder names to use for test b-trees

public mixed $table_dirs

$test_case_results

Used to store the results for each test sub case

public array<string|int, mixed> $test_case_results

$test_objects

Used to hold objects to be used in tests

public array<string|int, mixed> $test_objects

Methods

__construct()

Constructor should be overridden to do any set up that occurs before and test cases

public __construct() : mixed
Return values
mixed

assertEqual()

Checks that $x and $y are the same, the result of the test is added to $this->test_case_results

public assertEqual(mixed $x, mixed $y[, string $description = "" ]) : mixed
Parameters
$x : mixed

a first item to compare

$y : mixed

a second item to compare

$description : string = ""

information about this test subcase

Return values
mixed

assertFalse()

Checks that $x can coerced to false, the result of the test is added to $this->test_case_results

public assertFalse(mixed $x[, string $description = "" ]) : mixed
Parameters
$x : mixed

item to check

$description : string = ""

information about this test subcase

Return values
mixed

assertNotEqual()

Checks that $x and $y are not the same, the result of the test is added to $this->test_case_results

public assertNotEqual(mixed $x, mixed $y[, string $description = "" ]) : mixed
Parameters
$x : mixed

a first item to compare

$y : mixed

a second item to compare

$description : string = ""

information about this test subcase

Return values
mixed

assertTrue()

Checks that $x can coerced to true, the result of the test is added to $this->test_case_results

public assertTrue(mixed $x[, string $description = "" ]) : mixed
Parameters
$x : mixed

item to check

$description : string = ""

information about this test subcase

Return values
mixed

createTree()

Used to create a single hash table in the folder TEST_DIR . $max_items_per_file which allows at most $max_items_per_file to be stored in a bucket

public createTree(mixed $max_degree[, mixed $format = ["PRIMARY KEY" => ["KEY", -1], "VALUE" => "BLOB"] ]) : mixed
Parameters
$max_degree : mixed
$format : mixed = ["PRIMARY KEY" => ["KEY", -1], "VALUE" => "BLOB"]
Return values
mixed

putGetBlobTestCase()

Test putting items in bplustrees of odd sized nodes between 3 and 13 and then seeing if the items can be retrieved

public putGetBlobTestCase() : mixed
Return values
mixed

putGetTextTestCase()

Test putting items in bplustrees of odd sized nodes between 3 and 13 and then seeing if the items can be retrieved

public putGetTextTestCase() : mixed
Return values
mixed

run()

Execute each of the test cases of this unit test and return the results

public run([string $method = null ]) : array<string|int, mixed>
Parameters
$method : string = null

if not null then the method to run, else run all methods

Return values
array<string|int, mixed>

test case results

setUp()

Minimum degree is set to 2 and the number of key-value pairs is set to 25

public setUp() : mixed
Return values
mixed

tearDown()

Delete the B+-Tree files created during the test

public tearDown() : mixed
Return values
mixed

        

Search results