Package com.tibco.patterns.learn.rlink

## Class ConfRatio

- java.lang.Object
- - com.tibco.patterns.learn.rlink.ConfRatio

- All Implemented Interfaces:
    `Confidence`

      public class ConfRatio
      extends java.lang.Object
      implements Confidence

  Weighted true/false ratio confidence measure. Immutable class.

  This measure is available for model versions RFV5 and higher (ibi Patterns 5.4). It takes into account the feature values seen, and weights them based on the influence they have on the final score. It does not take into account the exact combination of feature scores.

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `ConfRatio()` | Create an instance with default values.
    `ConfRatio​(int minConfCount)` | Create an instance with specific parameter values.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | `getConfType()` | Return the confidence type.
    `double` | `getDblArg​(int idx)` | Return a double parameter.
    `int` | `getIntArg​(int idx)` | Return an integer parameter.
    `java.lang.String` | `toString()` |

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ConfRatio

          public ConfRatio()

      Create an instance with default values.

    - #### ConfRatio

          public ConfRatio​(int minConfCount)

      Create an instance with specific parameter values.
      Parameters:
        `minConfCount` - The number of training pairs needed to reach full confidence. This is the number of pairs that trained the same score region. Not all pairs train all regions, so this is not a count of the training pairs in the training set. Note this is a count of only the unique pairs. In other words the pairs seen on the first training iteration. Additional iterations do not increase the number of pairs for the purpose of this confidence measure.

  - ### Method Detail

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`

    - #### getConfType

          public int getConfType()

      Return the confidence type.
      Specified by:
        `getConfType` in interface `Confidence`
      Returns:
        the confidence type for the Weighted Ratio measure.

    - #### getIntArg

          public int getIntArg​(int idx)

      Return an integer parameter. The first parameter is the minimum confidence count.
      Specified by:
        `getIntArg` in interface `Confidence`
      Parameters:
        `idx` - the integer parameter index, zero based.
      Returns:
        The minimum confidence count for index 0, -1 otherwise.

    - #### getDblArg

          public double getDblArg​(int idx)

      Return a double parameter. There are no double parameters for this class.
      Specified by:
        `getDblArg` in interface `Confidence`
      Parameters:
        `idx` - the double parameter index, zero based.
      Returns:
        -1.0 for all indexes.