cts.linearModel

cts.linearModel(
   values as cts.reference[],
   [options as String[]],
   [query as cts.query?],
   [forest-ids as (Number|String)[]]
) as math.linearModel?

Summary

Returns a linear model that fits the frequency-weighted data set. The input data is a co-occurrence, formed from the specified value lexicons. The length of the input lexicon sequence should be 2, as currently only simple linear regression model is supported. The first lexicon should be the value of the dependent variable while the other lexicon should be the value of the independent variable. This function works like math:linear-model except each pair in the input lexicons is counted cts:frequency times. This function performs the calculation in parallel in all data nodes then aggregates the values.

Parameters
values	References to two range indexes. The types of the range indexes must be numeric. If the size of this sequence is not 2, the function returns the empty sequence.
options	Same as the "options" parameter in `cts:aggregate`.
query	Same as the "query" parameter in `cts:aggregate`.
forest-ids	Same as the "forest-ids" parameter in `cts:aggregate`.

Example

//   This query assumes range indexes of type unsignedLong
//   with positions are configured in the database for both
//   xval and yval. It generates some sample data and then
//   performs the aggregation in a separate transaction.

//  Generate data:
declareUpdate();

for (x=1; x<11; x++) {
  const j = 2 * x + 1;
  const uri = fn.concat(x, ".json");
  const vals = {xval:x, yval:j}
  const obj = {a:vals};
  xdmp.documentInsert(uri, obj);
  };

*******
// Run the following query:

cts.linearModel(
    [cts.jsonPropertyReference("yval", ["type=unsignedLong"]),
     cts.jsonPropertyReference("xval", ["type=unsignedLong"])],
    "item-frequency");

=>
math.linearModel(
  <math:linear-model intercept="0.352941176470588"
      coefficients="1.97058823529412" rsquared="0.995196571090748"
      xmlns:xs="http://www.w3.org/2001/XMLSchema"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:math="http://marklogic.com/xdmp/math"/>)