<html> <head> <title>Interface XRegressionCurveCalculator</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XRegressionCurveCalculator-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">chart2</a> :: </p> </td> </tr> <tr> <td class="title">interface XRegressionCurveCalculator</td> </tr> <tr> <td/></tr> <tr> <td/></tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#recalculateRegression">recalculateRegression</a></td> <td class="imsum_right">recalculates the parameters of the internal regression curve according to the <it>x</it>- and <it>y</it>-values given. </td> </tr> <tr> <td class="imsum_left"><a href="#getCurveValue">getCurveValue</a></td> <td class="imsum_right">calculates the value of the regression curve for <it>x</it>. </td> </tr> <tr> <td class="imsum_left"><a href="#getCurveValues">getCurveValues</a></td> <td class="imsum_right">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 <a href="#nPointCount">nPointCount</a> points. This is only allowed if the parameter <a href="#bMaySkipPointsInCalculation">bMaySkipPointsInCalculation</a> is set to <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#getCorrelationCoefficient">getCorrelationCoefficient</a></td> <td class="imsum_right">Returns the value of the correlation coefficient for the given regression. This value is often denoted as <it>r</it> or <it>R</it>. </td> </tr> <tr> <td class="imsum_left"><a href="#getRepresentation">getRepresentation</a></td> <td class="imsum_right">Retrieve a string showing the regression curve's function with calculated parameters. </td> </tr> <tr> <td class="imsum_left"><a href="#getFormattedRepresentation">getFormattedRepresentation</a></td> <td class="imsum_right">Returns a representation using the given number format for formatting all numbers contained in the formula. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="recalculateRegression" class="membertitle">recalculateRegression</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>recalculateRegression</b>(</td> <td valign="top">[in] sequence< double ></td> <td valign="bottom"> aXValues,</td> </tr> <tr> <td/><td valign="top">[in] sequence< double ></td> <td valign="bottom"> aYValues );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>recalculates the parameters of the internal regression curve according to the <it>x</it>- and <it>y</it>-values given. </dd> <dt><b>Parameter aXValues</b></dt> <dd>All x-values that represent the measurement points on which the regression is based </dd> <dt><b>Parameter aYValues</b></dt> <dd>All y-values that represent the measurement points on which the regression is based </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurveValue" class="membertitle">getCurveValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getCurveValue</b>(</td> <td valign="top">[in] double</td> <td valign="bottom"> x )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>calculates the value of the regression curve for <it>x</it>. </dd> <dt><b>Parameter x</b></dt> <dd>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. </dd> <dt><b>Returns</b></dt> <dd>If <it>x</it> is element of the domain of the regression curve function, the result is its value. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException If <it>x</it> is not part of the domain of the regression function. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurveValues" class="membertitle">getCurveValues</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealPoint2D.html">RealPoint2D</a> ></td> </tr> <tr> <td valign="top"><b>getCurveValues</b>(</td> <td valign="top">[in] double</td> <td valign="bottom"> min,</td> </tr> <tr> <td/><td valign="top">[in] double</td> <td valign="bottom"> max,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPointCount,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XScaling.html">XScaling</a></td> <td valign="bottom"> xScalingX,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XScaling.html">XScaling</a></td> <td valign="bottom"> xScalingY,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bMaySkipPointsInCalculation )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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 <a href="#nPointCount">nPointCount</a> points. This is only allowed if the parameter <a href="#bMaySkipPointsInCalculation">bMaySkipPointsInCalculation</a> is set to <b>true</b>. </dd> <dd><p>It is important that a renderer takes the scalings into account. When one of these parameters is unknown, no optimization must be done.</p> </dd> <dt><b>Parameter bMaySkipPointsInCalculation</b></dt> <dd>determines whether it is allowed to skip points in the calculation. When this parameter is <b>true</b> it is assumed that the underlying coordinate system is Cartesian. </dd> <dt><b>Parameter xScalingX</b></dt> <dd>a scaling that is used for the values in x-direction </dd> <dt><b>Parameter xScalingY</b></dt> <dd>a scaling that is used for the values in y-direction </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCorrelationCoefficient" class="membertitle">getCorrelationCoefficient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getCorrelationCoefficient</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the value of the correlation coefficient for the given regression. This value is often denoted as <it>r</it> or <it>R</it>. </dd> <dd><p>The value of <it>r</it> is signed. Often <it>r</it><sup>2</sup> is used instead of <it>r</it> to denote a regression curve's accuracy.</p> </dd> <dt><b>Returns</b></dt> <dd>The return value is the fraction of the variance in the data that is explained by the regression. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRepresentation" class="membertitle">getRepresentation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getRepresentation</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieve a string showing the regression curve's function with calculated parameters. </dd> <dt><b>Returns</b></dt> <dd>The string returned contains the regression curve's formula in a form <pre>"f(x) = ..."</pre>, where the calculated parts are filled out. For a linear regression you might get <pre>"f(x) = 0.341 x + 1.45"</pre>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFormattedRepresentation" class="membertitle">getFormattedRepresentation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getFormattedRepresentation</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XNumberFormatsSupplier.html">XNumberFormatsSupplier</a></td> <td valign="bottom"> xNumFmtSupplier,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nNumberFormatKey );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a representation using the given number format for formatting all numbers contained in the formula. </dd> <dt><b>See also</b></dt> <dd><a href="#getRepresentation">getRepresentation</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
