Project: Array Utilities Unit
Unit: DelphiDabbler.Lib.ArrayUtils
Record: TArrayUtils
Applies to: ~>0.1
class function Contains<T>(const AItem: T; const A: array of T;
const AEqualityComparer: TEqualityComparison<T>): Boolean;
overload; static;
class function Contains<T>(const AItem: T; const A: array of T;
const AEqualityComparer: IEqualityComparer<T>): Boolean;
overload; static;
class function Contains<T>(const AItem: T; const A: array of T): Boolean;
overload; static;
Checks if an array contains at least one element that tests equal to a given value.
Parameters:
AItem - The item to be searched for.
A - The array to be searched.
AEqualityComparer - An optional function or object that is used to test the equality of two values. Used to test AItem for equality with elements of A.
If AEqualityComparer is provided it must be one of:
If the parameter is omitted then the default equality comparer defined by Delphi’s TEqualityComparer<T>.Default method is used.
Returns:
True if A contains AItem or False if not.Using an equality comparer function:
procedure Contains_Eg1;
var
A: TArray<Integer>;
EqComparerFn: TEqualityComparison<Integer>;
begin
A := TArray<Integer>.Create(1, 2, 3);
EqComparerFn := function(const Left, Right: Integer): Boolean
begin
Result := Left = Right;
end;
Assert(TArrayUtils.Contains<Integer>(2, A, EqComparerFn) = True);
Assert(TArrayUtils.Contains<Integer>(4, A, EqComparerFn) = False);
end;
Using an equality comparer object:
procedure Contains_Eg2;
var
A: TArray<string>;
EqComparerObj: IEqualityComparer<string>;
begin
A := TArray<string>.Create('a', 'b', 'c');
EqComparerObj := TDelegatedEqualityComparer<string>.Create(
SameStr,
function(const Value: string): Integer
begin
// only do this if you KNOW the hash function won't be called
Result := 0;
end
);
Assert(TArrayUtils.Contains<string>('b', A, EqComparerObj) = True);
Assert(TArrayUtils.Contains<string>('d', A, EqComparerObj) = False);
end;