PHP Class Phpml\Math\Set

Inheritance: implements IteratorAggregate
Show file Open project: php-ai/php-ml Class Usage Examples

Public Methods

Method Description
__construct ( array $elements = [] )
add ( string | integer | float $element ) : Set
addAll ( array $elements ) : Set
cardinality ( ) : integer
cartesian ( Set $a, Set $b ) : array Creates the Cartesian product of A and B.
contains ( string | integer | float $element ) : boolean
containsAll ( array $elements ) : boolean
difference ( Set $a, Set $b ) : Set Creates the difference of A and B.
getIterator ( ) : ArrayIterator
intersection ( Set $a, Set $b ) : Set Creates the intersection of A and B.
isEmpty ( ) : boolean
power ( Set $a ) : array Creates the power set of A.
remove ( string | integer | float $element ) : Set
removeAll ( array $elements ) : Set
toArray ( ) : array
union ( Set $a, Set $b ) : Set Creates the union of A and B.

Private Methods

Method Description
sanitize ( array $elements ) : array Removes duplicates and rewrites index.

Method Details

__construct() public method

public __construct ( array $elements = [] )
$elements array

add() public method

public add ( string | integer | float $element ) : Set
$element string | integer | float
return Set

addAll() public method

public addAll ( array $elements ) : Set
$elements array
return Set

cardinality() public method

public cardinality ( ) : integer
return integer

cartesian() public static method

Creates the Cartesian product of A and B.
public static cartesian ( Set $a, Set $b ) : array
$a Set
$b Set
return array

contains() public method

public contains ( string | integer | float $element ) : boolean
$element string | integer | float
return boolean

containsAll() public method

public containsAll ( array $elements ) : boolean
$elements array
return boolean

difference() public static method

Creates the difference of A and B.
public static difference ( Set $a, Set $b ) : Set
$a Set
$b Set
return Set

getIterator() public method

intersection() public static method

Creates the intersection of A and B.
public static intersection ( Set $a, Set $b ) : Set
$a Set
$b Set
return Set

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

power() public static method

Creates the power set of A.
public static power ( Set $a ) : array
$a Set
return array

remove() public method

public remove ( string | integer | float $element ) : Set
$element string | integer | float
return Set

removeAll() public method

public removeAll ( array $elements ) : Set
$elements array
return Set

toArray() public method

public toArray ( ) : array
return array

union() public static method

Creates the union of A and B.
public static union ( Set $a, Set $b ) : Set
$a Set
$b Set
return Set