sc/source/ui/StatisticsDialogs/SamplingDialog.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  */
  10
  11 #include <sfx2/dispatch.hxx>
  12 #include <svl/zforlist.hxx>
  13 #include <svl/undo.hxx>
  14
  15 #include "rangelst.hxx"
  16 #include "scitems.hxx"
  17 #include "docsh.hxx"
  18 #include "document.hxx"
  19 #include "uiitems.hxx"
  20 #include "reffact.hxx"
  21 #include "strload.hxx"
  22 #include "random.hxx"
  23 #include "docfunc.hxx"
  24 #include "StatisticsDialogs.hrc"
  25
  26 #include <boost/random.hpp>
  27
  28 #include "SamplingDialog.hxx"
  29
  30 ScSamplingDialog::ScSamplingDialog(
  31                     SfxBindings* pSfxBindings, SfxChildWindow* pChildWindow,
  32                     Window* pParent, ScViewData* pViewData ) :
  33     ScAnyRefDlg     ( pSfxBindings, pChildWindow, pParent,
  34                       "SamplingDialog", "modules/scalc/ui/samplingdialog.ui" ),
  35     mViewData       ( pViewData ),
  36     mDocument       ( pViewData->GetDocument() ),
  37     mAddressDetails ( mDocument->GetAddressConvention(), 0, 0 ),
  38     mCurrentAddress ( pViewData->GetCurX(), pViewData->GetCurY(), pViewData->GetTabNo() ),
  39     mDialogLostFocus( false )
  40 {
  41     get(mpInputRangeLabel,  "input-range-label");
  42     get(mpInputRangeEdit,   "input-range-edit");
  43     get(mpInputRangeButton, "input-range-button");
  44     mpInputRangeEdit->SetReferences(this, mpInputRangeLabel);
  45     mpInputRangeButton->SetReferences(this, mpInputRangeEdit);
  46
  47     get(mpOutputRangeLabel,  "output-range-label");
  48     get(mpOutputRangeEdit,   "output-range-edit");
  49     get(mpOutputRangeButton, "output-range-button");
  50     mpOutputRangeEdit->SetReferences(this, mpOutputRangeLabel);
  51     mpOutputRangeButton->SetReferences(this, mpOutputRangeEdit);
  52
  53     get(mpSampleSize, "sample-size-spin");
  54     get(mpPeriod,     "period-spin");
  55
  56     get(mpRandomMethodRadio,   "random-method-radio");
  57     get(mpPeriodicMethodRadio, "periodic-method-radio");
  58
  59     get(mpButtonOk,     "ok");
  60     get(mpButtonApply,  "apply");
  61     get(mpButtonClose,  "close");
  62
  63     Init();
  64     GetRangeFromSelection();
  65 }
  66
  67 void ScSamplingDialog::Init()
  68 {
  69     mpButtonOk->SetClickHdl( LINK( this, ScSamplingDialog, OkClicked ) );
  70     mpButtonClose->SetClickHdl( LINK( this, ScSamplingDialog, CloseClicked ) );
  71     mpButtonApply->SetClickHdl( LINK( this, ScSamplingDialog, ApplyClicked ) );
  72     mpButtonOk->Enable(false);
  73     mpButtonApply->Enable(false);
  74
  75     Link aLink = LINK( this, ScSamplingDialog, GetFocusHandler );
  76     mpInputRangeEdit->SetGetFocusHdl( aLink );
  77     mpInputRangeButton->SetGetFocusHdl( aLink );
  78     mpOutputRangeEdit->SetGetFocusHdl( aLink );
  79     mpOutputRangeButton->SetGetFocusHdl( aLink );
  80
  81     aLink = LINK( this, ScSamplingDialog, LoseFocusHandler );
  82     mpInputRangeEdit->SetLoseFocusHdl( aLink );
  83     mpInputRangeButton->SetLoseFocusHdl( aLink );
  84     mpOutputRangeEdit->SetLoseFocusHdl( aLink );
  85     mpOutputRangeButton->SetLoseFocusHdl( aLink );
  86
  87     mpSampleSize->SetModifyHdl( LINK( this, ScSamplingDialog, SamplingSizeValueModified ));
  88
  89     mpPeriodicMethodRadio->SetToggleHdl( LINK( this, ScSamplingDialog, ToggleSamplingMethod ) );
  90     mpRandomMethodRadio->SetToggleHdl( LINK( this, ScSamplingDialog, ToggleSamplingMethod ) );
  91
  92     mpSampleSize->SetMin( 0 );
  93     mpSampleSize->SetMax( SAL_MAX_INT64 );
  94
  95     mpOutputRangeEdit->GrabFocus();
  96     mpPeriodicMethodRadio->Check(true);
  97
  98     ToggleSamplingMethod(NULL);
  99 }
 100
 101 void ScSamplingDialog::GetRangeFromSelection()
 102 {
 103     mViewData->GetSimpleArea(mInputRange);
 104     OUString aCurrentString(mInputRange.Format(SCR_ABS_3D, mDocument, mAddressDetails));
 105     mpInputRangeEdit->SetText(aCurrentString);
 106 }
 107
 108 ScSamplingDialog::~ScSamplingDialog()
 109 {}
 110
 111 void ScSamplingDialog::SetActive()
 112 {
 113     if ( mDialogLostFocus )
 114     {
 115         mDialogLostFocus = false;
 116         if( mpActiveEdit )
 117             mpActiveEdit->GrabFocus();
 118     }
 119     else
 120     {
 121         GrabFocus();
 122     }
 123     RefInputDone();
 124 }
 125
 126 sal_Bool ScSamplingDialog::Close()
 127 {
 128     return DoClose( ScSamplingDialogWrapper::GetChildWindowId() );
 129 }
 130
 131 void ScSamplingDialog::SetReference( const ScRange& rReferenceRange, ScDocument* pDocument )
 132 {
 133     if ( mpActiveEdit )
 134     {
 135         if ( rReferenceRange.aStart != rReferenceRange.aEnd )
 136             RefInputStart( mpActiveEdit );
 137
 138         OUString aReferenceString;
 139
 140         if ( mpActiveEdit == mpInputRangeEdit )
 141         {
 142             mInputRange = rReferenceRange;
 143             aReferenceString = mInputRange.Format(SCR_ABS_3D, pDocument, mAddressDetails);
 144             mpInputRangeEdit->SetRefString( aReferenceString );
 145         }
 146         else if ( mpActiveEdit == mpOutputRangeEdit )
 147         {
 148             mOutputAddress = rReferenceRange.aStart;
 149
 150             sal_uInt16 nFormat = ( mOutputAddress.Tab() == mCurrentAddress.Tab() ) ? SCA_ABS : SCA_ABS_3D;
 151             aReferenceString = mOutputAddress.Format(nFormat, pDocument, pDocument->GetAddressConvention());
 152             mpOutputRangeEdit->SetRefString( aReferenceString );
 153
 154             // Change sampling size according to output range selection
 155             sal_Int64 aSelectedSampleSize = rReferenceRange.aEnd.Row() - rReferenceRange.aStart.Row() + 1;
 156             if (aSelectedSampleSize > 1)
 157                 mpSampleSize->SetValue(aSelectedSampleSize);
 158             SamplingSizeValueModified(NULL);
 159
 160             // Enable OK, Cancel if output range is set
 161             mpButtonOk->Enable(!mpOutputRangeEdit->GetText().isEmpty());
 162             mpButtonApply->Enable(!mpOutputRangeEdit->GetText().isEmpty());
 163         }
 164     }
 165 }
 166
 167 ScRange ScSamplingDialog::PerformPeriodicSampling(ScDocShell* pDocShell)
 168 {
 169     ScAddress aStart = mInputRange.aStart;
 170     ScAddress aEnd   = mInputRange.aEnd;
 171
 172     SCTAB outTab = mOutputAddress.Tab();
 173     SCCOL outCol = mOutputAddress.Col();
 174     SCROW outRow = mOutputAddress.Row();
 175
 176     sal_Int64 aPeriod = mpPeriod->GetValue();
 177
 178     for (SCROW inTab = aStart.Tab(); inTab <= aEnd.Tab(); inTab++)
 179     {
 180         outCol = mOutputAddress.Col();
 181         for (SCCOL inCol = aStart.Col(); inCol <= aEnd.Col(); inCol++)
 182         {
 183             sal_Int64 i = 0;
 184             outRow = mOutputAddress.Row();
 185             for (SCROW inRow = aStart.Row(); inRow <= aEnd.Row(); inRow++)
 186             {
 187                 if (i % aPeriod == aPeriod - 1 ) // Sample the last of period
 188                 {
 189                     double aValue = mDocument->GetValue(ScAddress(inCol, inRow, inTab));
 190                     pDocShell->GetDocFunc().SetValueCell(ScAddress(outCol, outRow, outTab), aValue, true);
 191                     outRow++;
 192                 }
 193                 i++;
 194             }
 195             outCol++;
 196         }
 197         outTab++;
 198     }
 199
 200     return ScRange(mOutputAddress, ScAddress(outTab, outRow, outTab) );
 201 }
 202
 203 ScRange ScSamplingDialog::PerformRandomSampling(ScDocShell* pDocShell)
 204 {
 205     ScAddress aStart = mInputRange.aStart;
 206     ScAddress aEnd   = mInputRange.aEnd;
 207
 208     SCTAB outTab = mOutputAddress.Tab();
 209     SCCOL outCol = mOutputAddress.Col();
 210     SCROW outRow = mOutputAddress.Row();
 211
 212     TimeValue now;
 213     osl_getSystemTime(&now);
 214     boost::mt19937 seed(now.Nanosec);
 215     boost::uniform_01<boost::mt19937> rng(seed);
 216
 217     SCROW inRow;
 218
 219     sal_Int64 aSampleSize = mpSampleSize->GetValue();
 220
 221     for (SCROW inTab = aStart.Tab(); inTab <= aEnd.Tab(); inTab++)
 222     {
 223         outCol = mOutputAddress.Col();
 224         for (SCCOL inCol = aStart.Col(); inCol <= aEnd.Col(); inCol++)
 225         {
 226             SCROW aPopulationSize = (aEnd.Row() - aStart.Row()) + 1;
 227
 228             outRow = mOutputAddress.Row();
 229             inRow  = aStart.Row();
 230
 231             double aRandomValue;
 232
 233             while ((outRow - mOutputAddress.Row()) < aSampleSize)
 234             {
 235                 aRandomValue = rng();
 236
 237                 if ( (aPopulationSize - (inRow - aStart.Row())) * aRandomValue >= aSampleSize - (outRow - mOutputAddress.Row()) )
 238                 {
 239                     inRow++;
 240                 }
 241                 else
 242                 {
 243                     double aValue = mDocument->GetValue( ScAddress(inCol, inRow, inTab) );
 244                     pDocShell->GetDocFunc().SetValueCell(ScAddress(outCol, outRow, outTab), aValue, true);
 245                     inRow++;
 246                     outRow++;
 247                 }
 248             }
 249             outCol++;
 250         }
 251         outTab++;
 252     }
 253
 254     return ScRange(mOutputAddress, ScAddress(outTab, outRow, outTab) );
 255 }
 256
 257 void ScSamplingDialog::PerformSampling()
 258 {
 259     OUString aUndo( SC_STRLOAD( RID_STATISTICS_DLGS, STR_SAMPLING_UNDO_NAME));
 260     ScDocShell* pDocShell = mViewData->GetDocShell();
 261     svl::IUndoManager* pUndoManager = pDocShell->GetUndoManager();
 262
 263     ScRange aModifiedRange;
 264
 265     pUndoManager->EnterListAction( aUndo, aUndo );
 266
 267     if (mpRandomMethodRadio->IsChecked())
 268     {
 269         aModifiedRange = PerformRandomSampling(pDocShell);
 270     }
 271     else if (mpPeriodicMethodRadio->IsChecked())
 272     {
 273         aModifiedRange = PerformPeriodicSampling(pDocShell);
 274     }
 275
 276     pUndoManager->LeaveListAction();
 277     pDocShell->PostPaint(aModifiedRange, PAINT_GRID);
 278 }
 279
 280 IMPL_LINK( ScSamplingDialog, OkClicked, PushButton*, /*pButton*/ )
 281 {
 282     ApplyClicked(NULL);
 283     CloseClicked(NULL);
 284     return 0;
 285 }
 286
 287
 288 IMPL_LINK( ScSamplingDialog, ApplyClicked, PushButton*, /*pButton*/ )
 289 {
 290     PerformSampling();
 291     return 0;
 292 }
 293
 294 IMPL_LINK( ScSamplingDialog, CloseClicked, PushButton*, /*pButton*/ )
 295 {
 296     Close();
 297     return 0;
 298 }
 299
 300 IMPL_LINK( ScSamplingDialog, GetFocusHandler, Control*, pCtrl )
 301 {
 302     mpActiveEdit = NULL;
 303
 304     if(      (pCtrl == (Control*) mpInputRangeEdit)  || (pCtrl == (Control*) mpInputRangeButton) )
 305         mpActiveEdit = mpInputRangeEdit;
 306     else if( (pCtrl == (Control*) mpOutputRangeEdit) || (pCtrl == (Control*) mpOutputRangeButton) )
 307         mpActiveEdit = mpOutputRangeEdit;
 308
 309     if( mpActiveEdit )
 310         mpActiveEdit->SetSelection( Selection( 0, SELECTION_MAX ) );
 311
 312     return 0;
 313 }
 314
 315 IMPL_LINK_NOARG(ScSamplingDialog, LoseFocusHandler)
 316 {
 317     mDialogLostFocus = !IsActive();
 318     return 0;
 319 }
 320
 321 IMPL_LINK_NOARG(ScSamplingDialog, SamplingSizeValueModified)
 322 {
 323     sal_Int64 aPopulationSize = mInputRange.aEnd.Row() - mInputRange.aStart.Row() + 1;
 324     if (mpSampleSize->GetValue() > aPopulationSize)
 325         mpSampleSize->SetValue(aPopulationSize);
 326     return 0;
 327 }
 328
 329 IMPL_LINK_NOARG(ScSamplingDialog, ToggleSamplingMethod)
 330 {
 331     if (mpRandomMethodRadio->IsChecked())
 332     {
 333         mpPeriod->Enable(false);
 334         mpSampleSize->Enable(true);
 335     }
 336     else if (mpPeriodicMethodRadio->IsChecked())
 337     {
 338         mpPeriod->Enable(true);
 339         mpSampleSize->Enable(false);
 340     }
 341     return 0;
 342 }
 343
 344
 345 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */