offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com
  21 {
  22 module sun
  23 {
  24 module star
  25 {
  26 module chart2
  27 {
  28
  29 interface XRegressionCurveCalculator : com::sun::star::uno::XInterface
  30 {
  31     /** set calculation properties for curve calculation.
  32
  33         @param degree
  34             Degree of polynomial regression curve, value should be greater than zero
  35             If the curve is not polynomial, this property has no effect.
  36
  37         @param period
  38             Period of a moving average regression curve, value should be greater or equal to 2
  39             If the curve is not moving average regression curve, this property has no effect.
  40
  41         @param forceIntercept
  42             Should force the intercept value.
  43
  44         @param interceptValue
  45             Intercept value.
  46
  47         @param movingType
  48             Only if regression type is "Moving Average"
  49             @see ::com::sun::star::chart2::MovingAverageType
  50
  51     */
  52     void setRegressionProperties( [in] long degree,
  53                                   [in] boolean forceIntercept,
  54                                   [in] double interceptValue,
  55                                   [in] long period,
  56                                   [in] long movingType);
  57
  58     /** recalculates the parameters of the internal regression curve according to
  59         the <i>x</i>- and <i>y</i>-values given.
  60
  61         @param aXValues
  62             All x-values that represent the measurement points on
  63             which the regression is based
  64
  65         @param aYValues
  66             All y-values that represent the measurement points on
  67             which the regression is based
  68     */
  69     void recalculateRegression( [in] sequence< double > aXValues,
  70                                 [in] sequence< double > aYValues);
  71
  72
  73     /** calculates the value of the regression curve for <i>x</i>.
  74
  75         @param x
  76             The abscissa value for which the value of the regression
  77             curve should be calculated.  All numbers that are part of
  78             the domain of the regression function are valid.
  79
  80         @return
  81             If <i>x</i> is element of the domain of the regression
  82             curve function, the result is its value.
  83
  84         @throws com::sun::star::lang::IllegalArgumentException
  85             If <i>x</i> is not part of the domain of the regression
  86             function.
  87      */
  88     double getCurveValue( [in] double x )
  89         raises( com::sun::star::lang::IllegalArgumentException );
  90
  91     /** calculate multiple points of a regression curve at once. Note
  92         that this method may optimize the output by returning less
  93         points, e.g. for a line you may get only two resulting points
  94         instead of nPointCount() points.  This is only
  95         allowed if the parameter
  96         bMaySkipPointsInCalculation() is set to
  97         `TRUE`.
  98
  99         <p>It is important that a renderer takes the scalings into
 100         account. When one of these parameters is unknown, no
 101         optimization must be done.</p>
 102
 103         @param min the abscissa value for the starting point.
 104         @param max the abscissa value for the ending point.
 105
 106         @param nPointCount the number of points to calculate.
 107
 108         @param bMaySkipPointsInCalculation determines whether it is
 109                allowed to skip points in the calculation. When this
 110                parameter is `TRUE` it is assumed that the underlying
 111                coordinate system is Cartesian.
 112
 113         @param xScalingX a scaling that is used for the values in
 114                x-direction
 115
 116         @param xScalingY a scaling that is used for the values in
 117                y-direction
 118      */
 119     sequence< com::sun::star::geometry::RealPoint2D > getCurveValues(
 120         [in] double min,
 121         [in] double max,
 122         [in] long nPointCount,
 123         [in] XScaling xScalingX,
 124         [in] XScaling xScalingY,
 125         [in] boolean bMaySkipPointsInCalculation )
 126         raises( com::sun::star::lang::IllegalArgumentException );
 127
 128     /** Returns the value of the correlation coefficient for the given
 129         regression.  This value is often denoted as <i>r</i> or
 130         <i>R</i>.
 131
 132         <p>The value of <i>r</i> is signed.  Often
 133         <i>r</i><sup>2</sup> is used instead of <i>r</i> to denote
 134         a regression curve's accuracy.</p>
 135
 136         @return
 137             The return value is the fraction of the variance in the
 138             data that is explained by the regression.
 139      */
 140     double getCorrelationCoefficient();
 141
 142     /** Retrieve a string showing the regression curve's function with
 143         calculated parameters.
 144
 145         @return
 146             The string returned contains the regression curve's
 147             formula in a form <pre>"f(x) = ..."</pre>, where the
 148             calculated parts are filled out.  For a linear regression
 149             you might get <pre>"f(x) = 0.341 x + 1.45"</pre>.
 150      */
 151     string getRepresentation();
 152
 153     /** Returns a representation using the given number format for formatting all numbers
 154         contained in the formula. Wrap equation to fit in nFormulaLength characters
 155
 156         @see getRepresentation
 157      */
 158     string getFormattedRepresentation( [in] com::sun::star::util::XNumberFormatsSupplier xNumFmtSupplier,
 159                                        [in] long nNumberFormatKey,
 160                                        [in] long nFormulaLength );
 161
 162     /** Set the names of X and Y variables of the equation to replace "x" and "f(x)" in representation
 163
 164         @param aXName string of the name of X variable
 165         @param aYName string of the name of Y variable
 166     */
 167     void setXYNames( [in] string aXName,
 168                      [in] string aYName );
 169
 170 };
 171
 172 } ; // chart2
 173 } ; // com
 174 } ; // sun
 175 } ; // star
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */