Public Class Comparator

Properties Detail

• isDescending (Get)

  Public Property Get isDescending As Boolean

Methods Detail

• compare

  Public Function compare(source As Variant, target As Variant) As Integer
  Main function that does the comparison. Only needs to code for natural before/after. The outer function will reverse the result if the Comparator is instantiated as descending order or Collection has been reversed.
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Element being inserted
  2	target	Variant		Element at current position
  Code Sample
  %REM The following code is Comparator.compareAscDesc. %END REM Public Function compareAscDesc(source as Variant, target as Variant, collReversed as Boolean) as Integer compareAscDesc = compare(source, target) If (m_isDescending Xor collreversed) Then Return 0 - compareAscDesc Else Return compareAscDesc End Function

• compareAscDesc

  Public Function compareAscDesc(source As Variant, target As Variant, collReversed As Boolean) As Integer
  Compares source and target, returning -1 if source is before target, 0 if they are the same, 1 if source is after target. The value is reversed (so -1 changed to 1, 1 changed to -1) if: - Comparator is descending, but Collection is not reversed - Comparator is ascending, but Collection is reversed
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Element being inserted
  2	target	Variant		Element at current position
  3	collReversed	Boolean		Whether the parent Collection is reversed
  Code Sample
  %REM The following code is abbreviated code from Collection.getIndex. It compares each element against the value being checked, and if it matches, returns the current index. %END REM Public Function getIndex(checkValue as Variant) as Variant ForAll elem in Me.p_content) If (Me.Comparator.compareAscDesc(checkValue, elem, Me.p_isCollReversed) = 0) Then Return ListTag(elem) End ForAll End Function

• equals

  Public Function equals(source As Variant, target As Variant) As Boolean
  Function to determine if two values are determined to be identical. Used by remove, replace, and contains functions
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Element being inserted
  2	target	Variant		Element at current position
  Code Sample
  %REM The following code is Collection.getIndex(). %END REM ForAll elem in p_content If (Me.comparator.equals(checkValue, elem)) Then Return ListTag(elem) End ForAll

• New

  Public Sub New(isDescending As Boolean)
  idx	Argument	Data Type	Attributes	Comments
  1	isDescending	Boolean		Whether sorting should be in descending order