<commit_before>------------------------------------
Valdi\\Validator\\AbstractComparator
------------------------------------

.. toctree::

   Between
   Contains
   LengthBetween
   Max
   MaxLength
   Min
   MinLength
   Regexp
   Value

.. php:namespace: Valdi\\Validator

.. php:class:: AbstractComparator

    Validator for comparing values.

    .. php:attr:: amountOfParameters

        protected

        Holds the amount of parameters.

    .. php:attr:: type

        protected

        Holds the type of the validator.

    .. php:method:: isValidComparison($value, $parameters)

        Performs the comparison.

        :type $value: mixed
        :param $value: the first value to compare
        :type $parameters: mixed
        :param $parameters: the values to compare
        :returns: boolean true if value compares to the parameters

    .. php:method:: isAllNumeric()

        Checks whether all given parameters are numeric.

        :returns: boolean true if all values are numeric

    .. php:method:: isValid($value, $parameters)

        {@inheritdoc}

        :param $value:
        :param $parameters:

    .. php:method:: getInvalidDetails()

        {@inheritdoc}

    .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)

        Throws an exception if the parameters don't fulfill the expected
        parameter count.

        :type $name: string
        :param $name: the name of the validator
        :type $parameterAmount: integer
        :param $parameterAmount: the amount of expected parameters
        :type $parameters: string[]
        :param $parameters: the parameters
<commit_msg>removed doc toc entry causing havoc<commit_after>------------------------------------
Valdi\\Validator\\AbstractComparator
------------------------------------

.. toctree::

   Between
   LengthBetween
   Max
   MaxLength
   Min
   MinLength
   Regexp
   Value

.. php:namespace: Valdi\\Validator

.. php:class:: AbstractComparator

    Validator for comparing values.

    .. php:attr:: amountOfParameters

        protected

        Holds the amount of parameters.

    .. php:attr:: type

        protected

        Holds the type of the validator.

    .. php:method:: isValidComparison($value, $parameters)

        Performs the comparison.

        :type $value: mixed
        :param $value: the first value to compare
        :type $parameters: mixed
        :param $parameters: the values to compare
        :returns: boolean true if value compares to the parameters

    .. php:method:: isAllNumeric()

        Checks whether all given parameters are numeric.

        :returns: boolean true if all values are numeric

    .. php:method:: isValid($value, $parameters)

        {@inheritdoc}

        :param $value:
        :param $parameters:

    .. php:method:: getInvalidDetails()

        {@inheritdoc}

    .. php:method:: validateParameterCount($name, $parameterAmount, $parameters)

        Throws an exception if the parameters don't fulfill the expected
        parameter count.

        :type $name: string
        :param $name: the name of the validator
        :type $parameterAmount: integer
        :param $parameterAmount: the amount of expected parameters
        :type $parameters: string[]
        :param $parameters: the parameters

{'fraction_non_alphanumeric': 0.12379227053140096, 'fraction_numerical': 0.0, 'mean_word_length': 2.102059925093633, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '119806', 'n_tokens_mistral': 866, 'n_tokens_neox': 793, 'n_words': 288}