chart2/source/tools/RegressionCurveCalculator.cxx

   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 #include <RegressionCurveCalculator.hxx>
  21
  22 #include <comphelper/processfactory.hxx>
  23 #include <rtl/math.hxx>
  24
  25 #include <com/sun/star/lang/XServiceName.hpp>
  26 #include <com/sun/star/util/NumberFormatter.hpp>
  27
  28 #include <comphelper/numbers.hxx>
  29 #include <comphelper/extract.hxx>
  30
  31 using namespace ::com::sun::star;
  32
  33 using ::com::sun::star::uno::Reference;
  34 using ::com::sun::star::uno::Sequence;
  35
  36 namespace chart
  37 {
  38
  39 RegressionCurveCalculator::RegressionCurveCalculator() :
  40         m_fCorrelationCoeffitient(0.0),
  41         mDegree(2),
  42         mForceIntercept(false),
  43         mInterceptValue(0.0),
  44         mPeriod(2),
  45         mXName("x"), mYName("f(x)")
  46 {
  47     rtl::math::setNan( &m_fCorrelationCoeffitient );
  48     rtl::math::setNan( &mInterceptValue );
  49 }
  50
  51 RegressionCurveCalculator::~RegressionCurveCalculator()
  52 {}
  53
  54 bool RegressionCurveCalculator::isLinearScaling(
  55     const Reference< chart2::XScaling > & xScaling )
  56 {
  57     // no scaling means linear
  58     if( !xScaling.is())
  59         return true;
  60     uno::Reference< lang::XServiceName > xServiceName( xScaling, uno::UNO_QUERY );
  61     return xServiceName.is() && xServiceName->getServiceName() == "com.sun.star.chart2.LinearScaling";
  62 }
  63
  64 bool RegressionCurveCalculator::isLogarithmicScaling(
  65     const Reference< chart2::XScaling > & xScaling )
  66 {
  67     uno::Reference< lang::XServiceName > xServiceName( xScaling, uno::UNO_QUERY );
  68     return xServiceName.is() && xServiceName->getServiceName() == "com.sun.star.chart2.LogarithmicScaling";
  69 }
  70
  71 void RegressionCurveCalculator::setRegressionProperties(
  72     sal_Int32   aDegree,
  73     sal_Bool    aForceIntercept,
  74     double      aInterceptValue,
  75     sal_Int32   aPeriod )
  76 {
  77     mDegree = aDegree;
  78     mForceIntercept = aForceIntercept;
  79     mInterceptValue = aInterceptValue;
  80     mPeriod  = aPeriod;
  81 }
  82
  83 OUString RegressionCurveCalculator::getFormattedString(
  84     const Reference< util::XNumberFormatter >& xNumFormatter,
  85     sal_Int32 nNumberFormatKey,
  86     double fNumber, const sal_Int32* pStringLength /* = nullptr */ )
  87 {
  88     if ( pStringLength && *pStringLength <= 0 )
  89         return "###";
  90     OUString aResult;
  91
  92     if( xNumFormatter.is() )
  93     {
  94         bool bStandard = ::cppu::any2bool( ::comphelper::getNumberFormatProperty( xNumFormatter, nNumberFormatKey, "StandardFormat" ) );
  95         if( pStringLength && bStandard )
  96         {   // round fNumber to *pStringLength characters
  97             const sal_Int32 nMinDigit = 6; // minimum significant digits for General format
  98             sal_Int32 nSignificantDigit = ( *pStringLength <= nMinDigit ? nMinDigit : *pStringLength );
  99             aResult = OStringToOUString(
 100                         ::rtl::math::doubleToString( fNumber, rtl_math_StringFormat_G1, nSignificantDigit, '.', true ),
 101                                         RTL_TEXTENCODING_ASCII_US );
 102             // count characters different from significant digits (decimal separator, scientific notation)
 103             sal_Int32 nExtraChar = aResult.getLength() - *pStringLength;
 104             if ( nExtraChar > 0 && *pStringLength > nMinDigit )
 105             {
 106                 nSignificantDigit = *pStringLength - nExtraChar;
 107                 if ( nSignificantDigit < nMinDigit )
 108                     nSignificantDigit = nMinDigit;
 109                 aResult = OStringToOUString(
 110                     ::rtl::math::doubleToString( fNumber, rtl_math_StringFormat_G1, nSignificantDigit, '.', true ),
 111                                             RTL_TEXTENCODING_ASCII_US );
 112             }
 113             fNumber = ::rtl::math::stringToDouble( aResult, '.', ',' );
 114         }
 115         aResult = xNumFormatter->convertNumberToString( nNumberFormatKey, fNumber );
 116     }
 117     else
 118     {
 119         sal_Int32 nStringLength = 4;  // default length
 120         if ( pStringLength )
 121             nStringLength = *pStringLength;
 122         aResult = OStringToOUString(
 123                       ::rtl::math::doubleToString( fNumber, rtl_math_StringFormat_G1, nStringLength, '.', true ),
 124                       RTL_TEXTENCODING_ASCII_US );
 125     }
 126     return aResult;
 127 }
 128
 129 Sequence< geometry::RealPoint2D > SAL_CALL RegressionCurveCalculator::getCurveValues(
 130     double min, double max, ::sal_Int32 nPointCount,
 131     const Reference< chart2::XScaling >& xScalingX,
 132     const Reference< chart2::XScaling >& /* xScalingY */,
 133     sal_Bool /* bMaySkipPointsInCalculation */ )
 134 {
 135     if( nPointCount < 2 )
 136         throw lang::IllegalArgumentException();
 137
 138     // determine if scaling and inverse scaling for x-values work
 139     bool bDoXScaling( xScalingX.is());
 140     uno::Reference< chart2::XScaling > xInverseScaling;
 141     if( bDoXScaling )
 142         xInverseScaling.set( xScalingX->getInverseScaling());
 143     bDoXScaling = bDoXScaling && xInverseScaling.is();
 144
 145     Sequence< geometry::RealPoint2D > aResult( nPointCount );
 146
 147     double fMin( min );
 148     double fFact = (max - min) / double(nPointCount-1);
 149
 150     if( bDoXScaling )
 151     {
 152         fMin = xScalingX->doScaling( min );
 153         fFact = (xScalingX->doScaling( max ) - fMin) / double(nPointCount-1);
 154     }
 155
 156     for(sal_Int32 nP=0; nP<nPointCount; nP++)
 157     {
 158         double x = fMin + nP * fFact;
 159         if( bDoXScaling )
 160             x = xInverseScaling->doScaling( x );
 161         aResult[nP].X = x;
 162         aResult[nP].Y = getCurveValue( x );
 163     }
 164
 165     return aResult;
 166 }
 167
 168 double SAL_CALL RegressionCurveCalculator::getCorrelationCoefficient()
 169 {
 170     return m_fCorrelationCoeffitient;
 171 }
 172
 173 OUString SAL_CALL RegressionCurveCalculator::getRepresentation()
 174 {
 175     return ImplGetRepresentation( Reference< util::XNumberFormatter >(), 0 );
 176 }
 177
 178 OUString SAL_CALL RegressionCurveCalculator::getFormattedRepresentation(
 179     const Reference< util::XNumberFormatsSupplier > & xNumFmtSupplier,
 180     sal_Int32 nNumberFormatKey, sal_Int32 nFormulaLength )
 181 {
 182     // create and prepare a number formatter
 183     if( !xNumFmtSupplier.is())
 184         return getRepresentation();
 185     Reference< uno::XComponentContext > xContext( comphelper::getProcessComponentContext(), uno::UNO_SET_THROW );
 186     Reference< util::XNumberFormatter > xNumFormatter( util::NumberFormatter::create(xContext), uno::UNO_QUERY_THROW );
 187     xNumFormatter->attachNumberFormatsSupplier( xNumFmtSupplier );
 188
 189     if ( nFormulaLength > 0 )
 190         return ImplGetRepresentation( xNumFormatter, nNumberFormatKey, &nFormulaLength );
 191     return ImplGetRepresentation( xNumFormatter, nNumberFormatKey );
 192 }
 193
 194 void RegressionCurveCalculator::addStringToEquation(
 195         OUStringBuffer& aStrEquation, sal_Int32& nLineLength, OUStringBuffer const & aAddString, const sal_Int32* pMaxWidth)
 196 {
 197     if ( pMaxWidth && ( nLineLength + aAddString.getLength() > *pMaxWidth ) )
 198     {  // wrap line
 199         aStrEquation.append( "\n " ); // start new line with a blank
 200         nLineLength = 1;
 201     }
 202     aStrEquation.append( aAddString );
 203     nLineLength += aAddString.getLength();
 204 }
 205
 206 void SAL_CALL RegressionCurveCalculator::setXYNames( const OUString& aXName, const OUString& aYName )
 207 {
 208     if ( aXName.isEmpty() )
 209         mXName = OUString ("x");
 210     else
 211         mXName = aXName;
 212     if ( aYName.isEmpty() )
 213         mYName = OUString ("f(x)");
 214     else
 215         mYName = aYName;
 216 }
 217
 218 } //  namespace chart
 219
 220 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */