Update git submodules
[LibreOffice.git] / scaddins / idl / com / sun / star / sheet / addin / XAnalysis.idl
blobe05c66dbf541bda0ec08d82094aa0e3d322427a3
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 module com
22 module sun
24 module star
26 module sheet
28 module addin
30 /**
31 * Interface with analysis functions.
33 interface XAnalysis : com::sun::star::uno::XInterface
35 /// workday.
36 long getWorkday(
37 [in] com::sun::star::beans::XPropertySet xOptions,
38 [in] long nStartDate, [in] long nDays, [in] any aHolidays )
39 raises( com::sun::star::lang::IllegalArgumentException );
41 /// yearfrac.
42 double getYearfrac(
43 [in] com::sun::star::beans::XPropertySet xOptions,
44 [in] long StartDate, [in] long EndDate, [in] any Mode )
45 raises( com::sun::star::lang::IllegalArgumentException );
47 /// edate.
48 long getEdate(
49 [in] com::sun::star::beans::XPropertySet xOptions,
50 [in] long nStartDate, [in] long nNumOfMonths )
51 raises( com::sun::star::lang::IllegalArgumentException );
53 /// weeknum.
54 long getWeeknum(
55 [in] com::sun::star::beans::XPropertySet xOptions,
56 [in] long nStartDate, [in] long nMode )
57 raises( com::sun::star::lang::IllegalArgumentException );
59 /// eomonth.
60 long getEomonth(
61 [in] com::sun::star::beans::XPropertySet xOptions,
62 [in] long nStartDate, [in] long nMonths )
63 raises( com::sun::star::lang::IllegalArgumentException );
65 /// networkdays.
66 long getNetworkdays(
67 [in] com::sun::star::beans::XPropertySet xOptions,
68 [in] long StartDate, [in] long EndDate, [in] any Holidays )
69 raises( com::sun::star::lang::IllegalArgumentException );
71 /// iseven.
72 long getIseven( [in] long nValue )
73 raises( com::sun::star::lang::IllegalArgumentException );
75 /// isodd.
76 long getIsodd( [in] long nValue )
77 raises( com::sun::star::lang::IllegalArgumentException );
79 /// multinomial.
80 double getMultinomial(
81 [in] com::sun::star::beans::XPropertySet xOptions,
82 [in] sequence< sequence< long > > aValList,
83 [in] sequence< any > aOptVLst )
84 raises( com::sun::star::lang::IllegalArgumentException );
86 /// seriessum.
87 double getSeriessum(
88 [in] double X, [in] double N, [in] double M,
89 [in] sequence< sequence< double > > CoeffList )
90 raises( com::sun::star::lang::IllegalArgumentException );
92 // quotient.
93 double getQuotient( [in] double Num, [in] double Denum )
94 raises( com::sun::star::lang::IllegalArgumentException );
96 // mround.
97 double getMround( [in] double Number, [in] double Multiple )
98 raises( com::sun::star::lang::IllegalArgumentException );
100 // sqrtpi.
101 double getSqrtpi( [in] double Number )
102 raises( com::sun::star::lang::IllegalArgumentException );
104 // randbetween.
105 // Min is the smallest value randbetween will return
106 // Max is the largest value randbetween will return
107 double getRandbetween( [in] double Min, [in] double Max )
108 raises( com::sun::star::lang::IllegalArgumentException );
110 /// gcd.
111 double getGcd(
112 [in] com::sun::star::beans::XPropertySet xOptions,
113 [in] sequence< sequence< double > > FirstValList,
114 [in] sequence< any > OptionalValList )
115 raises( com::sun::star::lang::IllegalArgumentException );
117 /// lcm.
118 double getLcm(
119 [in] com::sun::star::beans::XPropertySet xOptions,
120 [in] sequence< sequence< double > > FirstValList,
121 [in] sequence< any > OptionalValList )
122 raises( com::sun::star::lang::IllegalArgumentException );
124 /// besseli.
125 double getBesseli( [in] double Num, [in] long Order )
126 raises( com::sun::star::lang::IllegalArgumentException,
127 com::sun::star::sheet::NoConvergenceException );
129 /// besselj.
130 double getBesselj( [in] double Num, [in] long Order )
131 raises( com::sun::star::lang::IllegalArgumentException,
132 com::sun::star::sheet::NoConvergenceException );
134 /// besselk.
135 double getBesselk( [in] double Num, [in] long Order )
136 raises( com::sun::star::lang::IllegalArgumentException,
137 com::sun::star::sheet::NoConvergenceException );
139 /// bessely.
140 double getBessely( [in] double Num, [in] long Order )
141 raises( com::sun::star::lang::IllegalArgumentException,
142 com::sun::star::sheet::NoConvergenceException );
144 /// bin2oct.
145 string getBin2Oct(
146 [in] com::sun::star::beans::XPropertySet xOptions,
147 [in] string BinaryNum, [in] any Places )
148 raises( com::sun::star::lang::IllegalArgumentException );
150 /// bin2dec.
151 double getBin2Dec( [in] string BinaryNum )
152 raises( com::sun::star::lang::IllegalArgumentException );
154 /// bin2hex.
155 string getBin2Hex(
156 [in] com::sun::star::beans::XPropertySet xOptions,
157 [in] string BinaryNum, [in] any Places )
158 raises( com::sun::star::lang::IllegalArgumentException );
160 /// oct2bin.
161 string getOct2Bin(
162 [in] com::sun::star::beans::XPropertySet xOptions,
163 [in] string OctalNum, [in] any Places )
164 raises( com::sun::star::lang::IllegalArgumentException );
166 /// oct2dec.
167 double getOct2Dec( [in] string OctalNum )
168 raises( com::sun::star::lang::IllegalArgumentException );
170 /// oct2hex.
171 string getOct2Hex(
172 [in] com::sun::star::beans::XPropertySet xOptions,
173 [in] string OctalNum, [in] any Places )
174 raises( com::sun::star::lang::IllegalArgumentException );
176 /// dec2bin.
177 string getDec2Bin(
178 [in] com::sun::star::beans::XPropertySet xOptions,
179 [in] long Value, [in] any Places )
180 raises( com::sun::star::lang::IllegalArgumentException );
182 /// dec2oct.
183 string getDec2Oct(
184 [in] com::sun::star::beans::XPropertySet xOptions,
185 [in] long Value, [in] any Places )
186 raises( com::sun::star::lang::IllegalArgumentException );
188 /// dec2hex.
189 string getDec2Hex(
190 [in] com::sun::star::beans::XPropertySet xOptions,
191 [in] double Value, [in] any Places )
192 raises( com::sun::star::lang::IllegalArgumentException );
194 /// hex2bin.
195 string getHex2Bin(
196 [in] com::sun::star::beans::XPropertySet xOptions,
197 [in] string HexadecimalValue, [in] any Places )
198 raises( com::sun::star::lang::IllegalArgumentException );
200 /// hex2dec.
201 double getHex2Dec( [in] string HexadecimalValue )
202 raises( com::sun::star::lang::IllegalArgumentException );
204 /// hex2oct.
205 string getHex2Oct(
206 [in] com::sun::star::beans::XPropertySet xOptions,
207 [in] string HexadecimalValue, [in] any Places )
208 raises( com::sun::star::lang::IllegalArgumentException );
210 /// delta.
211 long getDelta(
212 [in] com::sun::star::beans::XPropertySet xOptions,
213 [in] double Num1, [in] any Num2 )
214 raises( com::sun::star::lang::IllegalArgumentException );
216 /// erf.
217 double getErf(
218 [in] com::sun::star::beans::XPropertySet xOptions,
219 [in] double LowerLimit, [in] any UpperLimit )
220 raises( com::sun::star::lang::IllegalArgumentException );
222 /// erfc.
223 double getErfc( [in] double LowerLimit )
224 raises( com::sun::star::lang::IllegalArgumentException );
226 /// gestep.
227 long getGestep(
228 [in] com::sun::star::beans::XPropertySet xOptions,
229 [in] double Num, [in] any Step )
230 raises( com::sun::star::lang::IllegalArgumentException );
232 /// factdouble.
233 double getFactdouble( [in] long Num )
234 raises( com::sun::star::lang::IllegalArgumentException );
236 /// imabs.
237 double getImabs( [in] string Num )
238 raises( com::sun::star::lang::IllegalArgumentException );
240 /// imaginary.
241 double getImaginary( [in] string Num )
242 raises( com::sun::star::lang::IllegalArgumentException );
244 /// impower.
245 string getImpower( [in] string Num, [in] double Power )
246 raises( com::sun::star::lang::IllegalArgumentException );
248 /// imargument.
249 double getImargument( [in] string Num )
250 raises( com::sun::star::lang::IllegalArgumentException );
252 /// imcos.
253 string getImcos( [in] string Num )
254 raises( com::sun::star::lang::IllegalArgumentException );
256 /// imdiv.
257 string getImdiv( [in] string Num1, [in] string Num2 )
258 raises( com::sun::star::lang::IllegalArgumentException );
260 /// imexp.
261 string getImexp( [in] string Num )
262 raises( com::sun::star::lang::IllegalArgumentException );
264 /// imconjugate.
265 string getImconjugate( [in] string Num )
266 raises( com::sun::star::lang::IllegalArgumentException );
268 /// imln.
269 string getImln( [in] string Num )
270 raises( com::sun::star::lang::IllegalArgumentException );
272 /// imlog10.
273 string getImlog10( [in] string Num )
274 raises( com::sun::star::lang::IllegalArgumentException );
276 /// imlog2.
277 string getImlog2( [in] string Num )
278 raises( com::sun::star::lang::IllegalArgumentException );
280 /// improduct.
281 string getImproduct(
282 [in] com::sun::star::beans::XPropertySet xOptions,
283 [in] sequence< sequence< string > > Num1,
284 [in] sequence< any > NumberList )
285 raises( com::sun::star::lang::IllegalArgumentException );
287 /// imreal.
288 double getImreal( [in] string Num )
289 raises( com::sun::star::lang::IllegalArgumentException );
291 /// imsin.
292 string getImsin( [in] string Num )
293 raises( com::sun::star::lang::IllegalArgumentException );
295 /// imsub.
296 string getImsub( [in] string Num1, [in] string Num2 )
297 raises( com::sun::star::lang::IllegalArgumentException );
299 /// imsum.
300 string getImsum(
301 [in] com::sun::star::beans::XPropertySet xOptions,
302 [in] sequence< sequence< string > > Num1,
303 [in] sequence< any > OptNums )
304 raises( com::sun::star::lang::IllegalArgumentException );
306 /// imsqrt.
307 string getImsqrt( [in] string Num )
308 raises( com::sun::star::lang::IllegalArgumentException );
310 /// imtan.
311 string getImtan( [in] string Num )
312 raises( com::sun::star::lang::IllegalArgumentException );
314 /// imsec.
315 string getImsec( [in] string Num)
316 raises( com::sun::star::lang::IllegalArgumentException );
318 /// imcsc.
319 string getImcsc( [in] string Num )
320 raises( com::sun::star::lang::IllegalArgumentException );
322 /// imcot.
323 string getImcot( [in] string Num )
324 raises( com::sun::star::lang::IllegalArgumentException );
326 /// imsinh.
327 string getImsinh( [in] string Num )
328 raises( com::sun::star::lang::IllegalArgumentException );
330 /// imcosh.
331 string getImcosh( [in] string Num )
332 raises( com::sun::star::lang::IllegalArgumentException );
334 /// imsech.
335 string getImsech( [in] string Num)
336 raises( com::sun::star::lang::IllegalArgumentException );
338 /// imcsch.
339 string getImcsch( [in] string Num )
340 raises( com::sun::star::lang::IllegalArgumentException );
342 /// complex.
343 string getComplex( [in] double Real, [in] double Imaginary, [in] any Suffix )
344 raises( com::sun::star::lang::IllegalArgumentException );
346 /// convert.
347 double getConvert( [in] double Value, [in] string FromUnit, [in] string ToUnit )
348 raises( com::sun::star::lang::IllegalArgumentException );
351 /// amordegrc.
352 double getAmordegrc(
353 [in] com::sun::star::beans::XPropertySet xOptions,
354 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
355 [in] double Periode, [in] double Rate, [in] any Base )
356 raises( com::sun::star::lang::IllegalArgumentException );
358 /// amorlinc.
359 double getAmorlinc(
360 [in] com::sun::star::beans::XPropertySet xOptions,
361 [in] double Cost, [in] long Date, [in] long FirstPer, [in] double RestVal,
362 [in] double Periode, [in] double Rate, [in] any Base )
363 raises( com::sun::star::lang::IllegalArgumentException );
365 /// accrint.
366 double getAccrint(
367 [in] com::sun::star::beans::XPropertySet xOptions,
368 [in] long Issue, [in] long FirstInterest, [in] long Settlement, [in] double Rate,
369 [in] any Value, [in] long Frequency, [in] any Base )
370 raises( com::sun::star::lang::IllegalArgumentException );
372 /// accrintm.
373 double getAccrintm(
374 [in] com::sun::star::beans::XPropertySet xOptions,
375 [in] long Issue, [in] long Settlement, [in] double Rate, [in] any Value, [in] any Base )
376 raises( com::sun::star::lang::IllegalArgumentException );
378 /// received.
379 double getReceived(
380 [in] com::sun::star::beans::XPropertySet xOptions,
381 [in] long Settlement, [in] long Maturity, [in] double Investment, [in] double Discount,
382 [in] any Base )
383 raises( com::sun::star::lang::IllegalArgumentException );
385 /// disc.
386 double getDisc(
387 [in] com::sun::star::beans::XPropertySet xOptions,
388 [in] long Settlement, [in] long Maturity, [in] double Price, [in] double Redemption,
389 [in] any Base )
390 raises( com::sun::star::lang::IllegalArgumentException );
392 /// duration.
393 double getDuration(
394 [in] com::sun::star::beans::XPropertySet xOptions,
395 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
396 [in] long Frequency, [in] any Base )
397 raises( com::sun::star::lang::IllegalArgumentException );
399 /// effect.
400 double getEffect( [in] double Nomial, [in] long NumOfPeriods )
401 raises( com::sun::star::lang::IllegalArgumentException );
403 /// cumprinc.
404 double getCumprinc(
405 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
406 [in] long EndPeriode, [in] long PayType )
407 raises( com::sun::star::lang::IllegalArgumentException );
409 /// cumipmt.
410 double getCumipmt(
411 [in] double Rate, [in] long NumOfPeriods, [in] double Val, [in] long StartPeriode,
412 [in] long EndPeriode, [in] long PayType )
413 raises( com::sun::star::lang::IllegalArgumentException );
415 /// price.
416 double getPrice(
417 [in] com::sun::star::beans::XPropertySet xOptions,
418 [in] long Settlement, [in] long Maturity, [in] double Rate, [in] double Yield,
419 [in] double Redemption, [in] long Frequency, [in] any Base )
420 raises( com::sun::star::lang::IllegalArgumentException );
422 /// pricedisc.
423 double getPricedisc(
424 [in] com::sun::star::beans::XPropertySet xOptions,
425 [in] long Settlement, [in] long Maturity, [in] double Discont, [in] double Redemption,
426 [in] any Base )
427 raises( com::sun::star::lang::IllegalArgumentException );
429 /// pricemat.
430 double getPricemat(
431 [in] com::sun::star::beans::XPropertySet xOptions,
432 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate, [in] double Yield,
433 [in] any Base )
434 raises( com::sun::star::lang::IllegalArgumentException );
436 /// mduration.
437 double getMduration(
438 [in] com::sun::star::beans::XPropertySet xOptions,
439 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Yield,
440 [in] long Frequency, [in] any Base )
441 raises( com::sun::star::lang::IllegalArgumentException );
443 /// nominal.
444 double getNominal( [in] double Rate, [in] long NumOfPeriods )
445 raises( com::sun::star::lang::IllegalArgumentException );
447 /// dollarfr.
448 double getDollarfr( [in] double DollarDecimal, [in] long Fraction )
449 raises( com::sun::star::lang::IllegalArgumentException );
451 /// dollarde.
452 double getDollarde( [in] double DollarFractional, [in] long Fraction )
453 raises( com::sun::star::lang::IllegalArgumentException );
455 /// yield.
456 double getYield(
457 [in] com::sun::star::beans::XPropertySet xOptions,
458 [in] long Settlement, [in] long Maturity, [in] double Coupon, [in] double Price,
459 [in] double Redemption, [in] long Frequency, [in] any Base )
460 raises( com::sun::star::lang::IllegalArgumentException );
462 /// yielddisc.
463 double getYielddisc(
464 [in] com::sun::star::beans::XPropertySet xOptions,
465 [in] long Settlement, [in] long Maturity, [in] double Price,
466 [in] double Redemption, [in] any Base )
467 raises( com::sun::star::lang::IllegalArgumentException );
469 /// yieldmat.
470 double getYieldmat(
471 [in] com::sun::star::beans::XPropertySet xOptions,
472 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] double Rate,
473 [in] double Price, [in] any Base )
474 raises( com::sun::star::lang::IllegalArgumentException );
476 /// tbilleq.
477 double getTbilleq(
478 [in] com::sun::star::beans::XPropertySet xOptions,
479 [in] long Settlement, [in] long Maturity, [in] double Discont )
480 raises( com::sun::star::lang::IllegalArgumentException );
482 /// tbillprice.
483 double getTbillprice(
484 [in] com::sun::star::beans::XPropertySet xOptions,
485 [in] long Settlement, [in] long Maturity, [in] double Discont )
486 raises( com::sun::star::lang::IllegalArgumentException );
488 /// tbillyield.
489 double getTbillyield(
490 [in] com::sun::star::beans::XPropertySet xOptions,
491 [in] long Settlement, [in] long Maturity, [in] double Price )
492 raises( com::sun::star::lang::IllegalArgumentException );
494 /// oddfprice.
495 double getOddfprice(
496 [in] com::sun::star::beans::XPropertySet xOptions,
497 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
498 [in] double Rate, [in] double Yield, [in] double Redemption,
499 [in] long Frequency, [in] any Base )
500 raises( com::sun::star::lang::IllegalArgumentException );
502 /// oddfyield.
503 double getOddfyield(
504 [in] com::sun::star::beans::XPropertySet xOptions,
505 [in] long Settlement, [in] long Maturity, [in] long Issue, [in] long FirstCouponDate,
506 [in] double Rate, [in] double Price, [in] double Redemption,
507 [in] long Frequency, [in] any Base )
508 raises( com::sun::star::lang::IllegalArgumentException );
510 /// oddlprice.
511 double getOddlprice(
512 [in] com::sun::star::beans::XPropertySet xOptions,
513 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
514 [in] double Rate, [in] double Yield, [in] double Redemption,
515 [in] long Frequency, [in] any Base )
516 raises( com::sun::star::lang::IllegalArgumentException );
518 /// oddlyield.
519 double getOddlyield(
520 [in] com::sun::star::beans::XPropertySet xOptions,
521 [in] long Settlement, [in] long Maturity, [in] long LastInterest,
522 [in] double Rate, [in] double Price, [in] double Redemption,
523 [in] long Frequency, [in] any Base )
524 raises( com::sun::star::lang::IllegalArgumentException );
526 /// xirr.
527 double getXirr(
528 [in] com::sun::star::beans::XPropertySet xOptions,
529 [in] sequence< sequence< double > > Values,
530 [in] sequence< sequence< long > > Dates, [in] any Guess )
531 raises( com::sun::star::lang::IllegalArgumentException );
533 /// xnpv.
534 double getXnpv(
535 [in] double Rate,
536 [in] sequence< sequence< double > > Values,
537 [in] sequence< sequence< long > > Dates )
538 raises( com::sun::star::lang::IllegalArgumentException );
540 /// intrate.
541 double getIntrate(
542 [in] com::sun::star::beans::XPropertySet xOptions,
543 [in] long Settlement, [in] long Maturity,
544 [in] double Investment, [in] double Redemption, [in] any Base )
545 raises( com::sun::star::lang::IllegalArgumentException );
547 /// coupncd.
548 double getCoupncd(
549 [in] com::sun::star::beans::XPropertySet xOptions,
550 [in] long Settlement, [in] long Maturity,
551 [in] long Frequency, [in] any Base )
552 raises( com::sun::star::lang::IllegalArgumentException );
554 /// coupdays.
555 double getCoupdays(
556 [in] com::sun::star::beans::XPropertySet xOptions,
557 [in] long Settlement, [in] long Maturity,
558 [in] long Frequency, [in] any Base )
559 raises( com::sun::star::lang::IllegalArgumentException );
562 /// coupdaysnc.
563 double getCoupdaysnc(
564 [in] com::sun::star::beans::XPropertySet xOptions,
565 [in] long Settlement, [in] long Maturity,
566 [in] long Frequency, [in] any Base )
567 raises( com::sun::star::lang::IllegalArgumentException );
569 /// coupdaybs.
570 double getCoupdaybs(
571 [in] com::sun::star::beans::XPropertySet xOptions,
572 [in] long Settlement, [in] long Maturity,
573 [in] long Frequency, [in] any Base )
574 raises( com::sun::star::lang::IllegalArgumentException );
576 /// couppcd.
577 double getCouppcd(
578 [in] com::sun::star::beans::XPropertySet xOptions,
579 [in] long Settlement, [in] long Maturity,
580 [in] long Frequency, [in] any Base )
581 raises( com::sun::star::lang::IllegalArgumentException );
583 /// coupnum.
584 double getCoupnum(
585 [in] com::sun::star::beans::XPropertySet xOptions,
586 [in] long Settlement, [in] long Maturity,
587 [in] long Frequency, [in] any Base )
588 raises( com::sun::star::lang::IllegalArgumentException );
590 /// fvschedule.
591 double getFvschedule( [in] double Principal, [in] sequence< sequence< double > > Schedule )
592 raises( com::sun::star::lang::IllegalArgumentException );
600 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */