cast-comparison v1.0.5

cast-comparison

Classification and comparison of Javascript objects.

Installing

Using Npm

1. Run npm install cast-comparison
2. Import it into your script import Comparator from 'cast-comparison'

Downloading File

1. Download "comparator.umd.js" from the latest release
2. Add it into your html <script src="comparator.umd.js"></script>

Usage Example

Let's create an optional config. We will clarify how to calculate an inaccurate match for properties in our objects.

  var config = {
    wheels: [0.2, Comparator.BETWEEN],
    length: [0.2, Comparator.UP],
    seats: [0.3, Comparator.BETWEEN],
    maxSpeed: [0.2, Comparator.DOWN]
  }

Take a look at the arrays that are assigned to the properties of our object:

[0.2, Cast.BETWEEN]

The first value is the spread of inaccuracy. Indicates at what maximum difference the parameters will be considered similar. Possible values: from 0 to 1.

The second value is the propagations of inaccuracy. Specifies the range in which the compared value will be considered similar. Possible values:

'between' - any value between the minimum and maximum in the group

'up' - any value that is greater than the minimum in the group

'down' - any value that is less than the maximum in the group

null - no propagation.

Now create a template based on some data we know

  var trucksComparator = new Comparator(config)

  var knownTrucks = [
    { wheels: 6, length: 10, seats: 3, maxSpeed: 180 },
    { wheels: 6, length: 12, seats: 3, maxSpeed: 160 },
    { wheels: 4, length: 6, seats: 2, maxSpeed: 180 },
    { wheels: 4, length: 8, seats: 2, maxSpeed: 180 },
    { wheels: 8, length: 12, seats: 5, maxSpeed: 160 }
  ]

  trucksComparator.train(knownTrucks)

Test

  var firstCar = { wheels: 6, length: 10, seats: 2, maxSpeed: 160 } // truck
  var secondCar = { wheels: 4, length: 4, seats: 4, maxSpeed: 200 } // passenger car

  console.log(`Probability that the firstCar is a truck: ${trucksComparator.test(firstCar) * 100}%`)
  console.log(`Probability that the secondCar is a truck: ${trucksComparator.test(secondCar) * 100}%`)