Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: chart2 ::

interface XRegressionCurveCalculator
Methods' Summary
recalculateRegression recalculates the parameters of the internal regression curve according to the x- and y-values given.  
getCurveValue calculates the value of the regression curve for x.  
getCurveValues calculate multiple points of a regression curve at once. Note that this method may optimize the output by returning less points, e.g. for a line you may get only two resulting points instead of nPointCount points. This is only allowed if the parameter bMaySkipPointsInCalculation is set to true.  
getCorrelationCoefficient Returns the value of the correlation coefficient for the given regression. This value is often denoted as r or R.  
getRepresentation Retrieve a string showing the regression curve's function with calculated parameters.  
getFormattedRepresentation Returns a representation using the given numnber format for formatting all numbers contained in the formula.  
Methods' Details
recalculateRegression
void
recalculateRegression( [in] sequence< double >  aXValues,
[in] sequence< double >  aYValues );
Description
recalculates the parameters of the internal regression curve according to the x- and y-values given.
Parameter aXValues
All x-values that represent the measurement points on which the regression is based
Parameter aYValues
All y-values that represent the measurement points on which the regression is based
getCurveValue
double
getCurveValue( [in] double  x )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
calculates the value of the regression curve for x.
Parameter x
The abscissa value for which the value of the regression curve should be calculated. All numbers that are part of the domain of the regression function are valid.
Returns
If x is element of the domain of the regression curve function, the result is its value.
Throws
com::sun::star::lang::IllegalArgumentException If x is not part of the domain of the regression function.
getCurveValues
sequence< ::com::sun::star::geometry::RealPoint2D >
getCurveValues( [in] double  min,
[in] double  max,
[in] long  nPointCount,
[in] XScaling  xScalingX,
[in] XScaling  xScalingY,
[in] boolean  bMaySkipPointsInCalculation )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
calculate multiple points of a regression curve at once. Note that this method may optimize the output by returning less points, e.g. for a line you may get only two resulting points instead of nPointCount points. This is only allowed if the parameter bMaySkipPointsInCalculation is set to true.

It is important that a renderer takes the scalings into account. When one of these parameters is unknown, no optimization must be done.

Parameter bMaySkipPointsInCalculation
determines whether it is allowed to skip points in the calculation. When this parameter is true it is assumed that the underlying coordinate system is cartesian.
Parameter xScalingX
a scaling that is used for the values in x-direction
Parameter xScalingY
a scaling that is used for the values in y-direction
getCorrelationCoefficient
double
getCorrelationCoefficient();
Description
Returns the value of the correlation coefficient for the given regression. This value is often denoted as r or R.

The value of r is signed. Often r2 is used instead of r to denote a regression curve's accuray.

Returns
The return value is the fraction of the variance in the data that is explained by the regression.
getRepresentation
string
getRepresentation();
Description
Retrieve a string showing the regression curve's function with calculated parameters.
Returns
The string returned contains the regression curve's formula in a form 
"f(x) = ..."
, where the calculated parts are filled out. For a linear regression you might get 
"f(x) = 0.341 x + 1.45"
.
getFormattedRepresentation
string
getFormattedRepresentation( [in] ::com::sun::star::util::XNumberFormatsSupplier  xNumFmtSupplier,
[in] long  nNumberFormatKey );
Description
Returns a representation using the given numnber format for formatting all numbers contained in the formula.
See also
getRepresentation
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.