calc.go 107 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835
  1. // Copyright 2016 - 2021 The excelize Authors. All rights reserved. Use of
  2. // this source code is governed by a BSD-style license that can be found in
  3. // the LICENSE file.
  4. //
  5. // Package excelize providing a set of functions that allow you to write to
  6. // and read from XLSX / XLSM / XLTM files. Supports reading and writing
  7. // spreadsheet documents generated by Microsoft Exce™ 2007 and later. Supports
  8. // complex components by high compatibility, and provided streaming API for
  9. // generating or reading data from a worksheet with huge amounts of data. This
  10. // library needs Go version 1.10 or later.
  11. package excelize
  12. import (
  13. "bytes"
  14. "container/list"
  15. "errors"
  16. "fmt"
  17. "math"
  18. "math/rand"
  19. "reflect"
  20. "regexp"
  21. "sort"
  22. "strconv"
  23. "strings"
  24. "time"
  25. "unicode"
  26. "github.com/xuri/efp"
  27. )
  28. // Excel formula errors
  29. const (
  30. formulaErrorDIV = "#DIV/0!"
  31. formulaErrorNAME = "#NAME?"
  32. formulaErrorNA = "#N/A"
  33. formulaErrorNUM = "#NUM!"
  34. formulaErrorVALUE = "#VALUE!"
  35. formulaErrorREF = "#REF!"
  36. formulaErrorNULL = "#NULL"
  37. formulaErrorSPILL = "#SPILL!"
  38. formulaErrorCALC = "#CALC!"
  39. formulaErrorGETTINGDATA = "#GETTING_DATA"
  40. )
  41. // Numeric precision correct numeric values as legacy Excel application
  42. // https://en.wikipedia.org/wiki/Numeric_precision_in_Microsoft_Excel In the
  43. // top figure the fraction 1/9000 in Excel is displayed. Although this number
  44. // has a decimal representation that is an infinite string of ones, Excel
  45. // displays only the leading 15 figures. In the second line, the number one
  46. // is added to the fraction, and again Excel displays only 15 figures.
  47. const numericPrecision = 1000000000000000
  48. // cellRef defines the structure of a cell reference.
  49. type cellRef struct {
  50. Col int
  51. Row int
  52. Sheet string
  53. }
  54. // cellRef defines the structure of a cell range.
  55. type cellRange struct {
  56. From cellRef
  57. To cellRef
  58. }
  59. // formula criteria condition enumeration.
  60. const (
  61. _ byte = iota
  62. criteriaEq
  63. criteriaLe
  64. criteriaGe
  65. criteriaL
  66. criteriaG
  67. criteriaBeg
  68. criteriaEnd
  69. criteriaErr
  70. )
  71. // formulaCriteria defined formula criteria parser result.
  72. type formulaCriteria struct {
  73. Type byte
  74. Condition string
  75. }
  76. // ArgType is the type if formula argument type.
  77. type ArgType byte
  78. // Formula argument types enumeration.
  79. const (
  80. ArgUnknown ArgType = iota
  81. ArgNumber
  82. ArgString
  83. ArgList
  84. ArgMatrix
  85. ArgError
  86. ArgEmpty
  87. )
  88. // formulaArg is the argument of a formula or function.
  89. type formulaArg struct {
  90. Number float64
  91. String string
  92. List []formulaArg
  93. Matrix [][]formulaArg
  94. Boolean bool
  95. Error string
  96. Type ArgType
  97. }
  98. // Value returns a string data type of the formula argument.
  99. func (fa formulaArg) Value() (value string) {
  100. switch fa.Type {
  101. case ArgNumber:
  102. if fa.Boolean {
  103. if fa.Number == 0 {
  104. return "FALSE"
  105. }
  106. return "TRUE"
  107. }
  108. return fmt.Sprintf("%g", fa.Number)
  109. case ArgString:
  110. return fa.String
  111. case ArgError:
  112. return fa.Error
  113. }
  114. return
  115. }
  116. // ToNumber returns a formula argument with number data type.
  117. func (fa formulaArg) ToNumber() formulaArg {
  118. var n float64
  119. var err error
  120. switch fa.Type {
  121. case ArgString:
  122. n, err = strconv.ParseFloat(fa.String, 64)
  123. if err != nil {
  124. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  125. }
  126. case ArgNumber:
  127. n = fa.Number
  128. }
  129. return newNumberFormulaArg(n)
  130. }
  131. // ToBool returns a formula argument with boolean data type.
  132. func (fa formulaArg) ToBool() formulaArg {
  133. var b bool
  134. var err error
  135. switch fa.Type {
  136. case ArgString:
  137. b, err = strconv.ParseBool(fa.String)
  138. if err != nil {
  139. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  140. }
  141. case ArgNumber:
  142. if fa.Boolean && fa.Number == 1 {
  143. b = true
  144. }
  145. }
  146. return newBoolFormulaArg(b)
  147. }
  148. // formulaFuncs is the type of the formula functions.
  149. type formulaFuncs struct{}
  150. // tokenPriority defined basic arithmetic operator priority.
  151. var tokenPriority = map[string]int{
  152. "^": 5,
  153. "*": 4,
  154. "/": 4,
  155. "+": 3,
  156. "-": 3,
  157. "=": 2,
  158. "<>": 2,
  159. "<": 2,
  160. "<=": 2,
  161. ">": 2,
  162. ">=": 2,
  163. "&": 1,
  164. }
  165. // CalcCellValue provides a function to get calculated cell value. This
  166. // feature is currently in working processing. Array formula, table formula
  167. // and some other formulas are not supported currently.
  168. //
  169. // Supported formulas:
  170. //
  171. // ABS
  172. // ACOS
  173. // ACOSH
  174. // ACOT
  175. // ACOTH
  176. // AND
  177. // ARABIC
  178. // ASIN
  179. // ASINH
  180. // ATAN2
  181. // ATANH
  182. // BASE
  183. // CEILING
  184. // CEILING.MATH
  185. // CEILING.PRECISE
  186. // CHOOSE
  187. // CLEAN
  188. // COMBIN
  189. // COMBINA
  190. // COS
  191. // COSH
  192. // COT
  193. // COTH
  194. // COUNTA
  195. // CSC
  196. // CSCH
  197. // DATE
  198. // DECIMAL
  199. // DEGREES
  200. // EVEN
  201. // EXP
  202. // FACT
  203. // FACTDOUBLE
  204. // FLOOR
  205. // FLOOR.MATH
  206. // FLOOR.PRECISE
  207. // GCD
  208. // IF
  209. // INT
  210. // ISBLANK
  211. // ISERR
  212. // ISERROR
  213. // ISEVEN
  214. // ISNA
  215. // ISNONTEXT
  216. // ISNUMBER
  217. // ISODD
  218. // ISO.CEILING
  219. // LCM
  220. // LEN
  221. // LN
  222. // LOG
  223. // LOG10
  224. // LOWER
  225. // MDETERM
  226. // MEDIAN
  227. // MOD
  228. // MROUND
  229. // MULTINOMIAL
  230. // MUNIT
  231. // NA
  232. // ODD
  233. // OR
  234. // PI
  235. // POWER
  236. // PRODUCT
  237. // PROPER
  238. // QUOTIENT
  239. // RADIANS
  240. // RAND
  241. // RANDBETWEEN
  242. // ROUND
  243. // ROUNDDOWN
  244. // ROUNDUP
  245. // SEC
  246. // SECH
  247. // SIGN
  248. // SIN
  249. // SINH
  250. // SQRT
  251. // SQRTPI
  252. // SUM
  253. // SUMIF
  254. // SUMSQ
  255. // TAN
  256. // TANH
  257. // TRIM
  258. // TRUNC
  259. // UPPER
  260. //
  261. func (f *File) CalcCellValue(sheet, cell string) (result string, err error) {
  262. var (
  263. formula string
  264. token efp.Token
  265. )
  266. if formula, err = f.GetCellFormula(sheet, cell); err != nil {
  267. return
  268. }
  269. ps := efp.ExcelParser()
  270. tokens := ps.Parse(formula)
  271. if tokens == nil {
  272. return
  273. }
  274. if token, err = f.evalInfixExp(sheet, tokens); err != nil {
  275. return
  276. }
  277. result = token.TValue
  278. isNum, precision := isNumeric(result)
  279. if isNum && precision > 15 {
  280. num, _ := roundPrecision(result)
  281. result = strings.ToUpper(num)
  282. }
  283. return
  284. }
  285. // getPriority calculate arithmetic operator priority.
  286. func getPriority(token efp.Token) (pri int) {
  287. pri, _ = tokenPriority[token.TValue]
  288. if token.TValue == "-" && token.TType == efp.TokenTypeOperatorPrefix {
  289. pri = 6
  290. }
  291. if isBeginParenthesesToken(token) { // (
  292. pri = 0
  293. }
  294. return
  295. }
  296. // newNumberFormulaArg constructs a number formula argument.
  297. func newNumberFormulaArg(n float64) formulaArg {
  298. if math.IsNaN(n) {
  299. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  300. }
  301. return formulaArg{Type: ArgNumber, Number: n}
  302. }
  303. // newStringFormulaArg constructs a string formula argument.
  304. func newStringFormulaArg(s string) formulaArg {
  305. return formulaArg{Type: ArgString, String: s}
  306. }
  307. // newMatrixFormulaArg constructs a matrix formula argument.
  308. func newMatrixFormulaArg(m [][]formulaArg) formulaArg {
  309. return formulaArg{Type: ArgMatrix, Matrix: m}
  310. }
  311. // newListFormulaArg create a list formula argument.
  312. func newListFormulaArg(l []formulaArg) formulaArg {
  313. return formulaArg{Type: ArgList, List: l}
  314. }
  315. // newBoolFormulaArg constructs a boolean formula argument.
  316. func newBoolFormulaArg(b bool) formulaArg {
  317. var n float64
  318. if b {
  319. n = 1
  320. }
  321. return formulaArg{Type: ArgNumber, Number: n, Boolean: true}
  322. }
  323. // newErrorFormulaArg create an error formula argument of a given type with a
  324. // specified error message.
  325. func newErrorFormulaArg(formulaError, msg string) formulaArg {
  326. return formulaArg{Type: ArgError, String: formulaError, Error: msg}
  327. }
  328. // newEmptyFormulaArg create an empty formula argument.
  329. func newEmptyFormulaArg() formulaArg {
  330. return formulaArg{Type: ArgEmpty}
  331. }
  332. // evalInfixExp evaluate syntax analysis by given infix expression after
  333. // lexical analysis. Evaluate an infix expression containing formulas by
  334. // stacks:
  335. //
  336. // opd - Operand
  337. // opt - Operator
  338. // opf - Operation formula
  339. // opfd - Operand of the operation formula
  340. // opft - Operator of the operation formula
  341. //
  342. // Evaluate arguments of the operation formula by list:
  343. //
  344. // args - Arguments of the operation formula
  345. //
  346. // TODO: handle subtypes: Nothing, Text, Logical, Error, Concatenation, Intersection, Union
  347. //
  348. func (f *File) evalInfixExp(sheet string, tokens []efp.Token) (efp.Token, error) {
  349. var err error
  350. opdStack, optStack, opfStack, opfdStack, opftStack, argsStack := NewStack(), NewStack(), NewStack(), NewStack(), NewStack(), NewStack()
  351. for i := 0; i < len(tokens); i++ {
  352. token := tokens[i]
  353. // out of function stack
  354. if opfStack.Len() == 0 {
  355. if err = f.parseToken(sheet, token, opdStack, optStack); err != nil {
  356. return efp.Token{}, err
  357. }
  358. }
  359. // function start
  360. if isFunctionStartToken(token) {
  361. opfStack.Push(token)
  362. argsStack.Push(list.New().Init())
  363. continue
  364. }
  365. // in function stack, walk 2 token at once
  366. if opfStack.Len() > 0 {
  367. var nextToken efp.Token
  368. if i+1 < len(tokens) {
  369. nextToken = tokens[i+1]
  370. }
  371. // current token is args or range, skip next token, order required: parse reference first
  372. if token.TSubType == efp.TokenSubTypeRange {
  373. if !opftStack.Empty() {
  374. // parse reference: must reference at here
  375. result, err := f.parseReference(sheet, token.TValue)
  376. if err != nil {
  377. return efp.Token{TValue: formulaErrorNAME}, err
  378. }
  379. if result.Type != ArgString {
  380. return efp.Token{}, errors.New(formulaErrorVALUE)
  381. }
  382. opfdStack.Push(efp.Token{
  383. TType: efp.TokenTypeOperand,
  384. TSubType: efp.TokenSubTypeNumber,
  385. TValue: result.String,
  386. })
  387. continue
  388. }
  389. if nextToken.TType == efp.TokenTypeArgument || nextToken.TType == efp.TokenTypeFunction {
  390. // parse reference: reference or range at here
  391. result, err := f.parseReference(sheet, token.TValue)
  392. if err != nil {
  393. return efp.Token{TValue: formulaErrorNAME}, err
  394. }
  395. if result.Type == ArgUnknown {
  396. return efp.Token{}, errors.New(formulaErrorVALUE)
  397. }
  398. argsStack.Peek().(*list.List).PushBack(result)
  399. continue
  400. }
  401. }
  402. // check current token is opft
  403. if err = f.parseToken(sheet, token, opfdStack, opftStack); err != nil {
  404. return efp.Token{}, err
  405. }
  406. // current token is arg
  407. if token.TType == efp.TokenTypeArgument {
  408. for !opftStack.Empty() {
  409. // calculate trigger
  410. topOpt := opftStack.Peek().(efp.Token)
  411. if err := calculate(opfdStack, topOpt); err != nil {
  412. return efp.Token{}, err
  413. }
  414. opftStack.Pop()
  415. }
  416. if !opfdStack.Empty() {
  417. argsStack.Peek().(*list.List).PushBack(formulaArg{
  418. String: opfdStack.Pop().(efp.Token).TValue,
  419. Type: ArgString,
  420. })
  421. }
  422. continue
  423. }
  424. // current token is logical
  425. if token.TType == efp.OperatorsInfix && token.TSubType == efp.TokenSubTypeLogical {
  426. }
  427. if token.TType == efp.TokenTypeOperand && token.TSubType == efp.TokenSubTypeLogical {
  428. argsStack.Peek().(*list.List).PushBack(formulaArg{
  429. String: token.TValue,
  430. Type: ArgString,
  431. })
  432. }
  433. // current token is text
  434. if token.TType == efp.TokenTypeOperand && token.TSubType == efp.TokenSubTypeText {
  435. argsStack.Peek().(*list.List).PushBack(formulaArg{
  436. String: token.TValue,
  437. Type: ArgString,
  438. })
  439. }
  440. if err = evalInfixExpFunc(token, nextToken, opfStack, opdStack, opftStack, opfdStack, argsStack); err != nil {
  441. return efp.Token{}, err
  442. }
  443. }
  444. }
  445. for optStack.Len() != 0 {
  446. topOpt := optStack.Peek().(efp.Token)
  447. if err = calculate(opdStack, topOpt); err != nil {
  448. return efp.Token{}, err
  449. }
  450. optStack.Pop()
  451. }
  452. if opdStack.Len() == 0 {
  453. return efp.Token{}, errors.New("formula not valid")
  454. }
  455. return opdStack.Peek().(efp.Token), err
  456. }
  457. // evalInfixExpFunc evaluate formula function in the infix expression.
  458. func evalInfixExpFunc(token, nextToken efp.Token, opfStack, opdStack, opftStack, opfdStack, argsStack *Stack) error {
  459. if !isFunctionStopToken(token) {
  460. return nil
  461. }
  462. // current token is function stop
  463. for !opftStack.Empty() {
  464. // calculate trigger
  465. topOpt := opftStack.Peek().(efp.Token)
  466. if err := calculate(opfdStack, topOpt); err != nil {
  467. return err
  468. }
  469. opftStack.Pop()
  470. }
  471. // push opfd to args
  472. if opfdStack.Len() > 0 {
  473. argsStack.Peek().(*list.List).PushBack(formulaArg{
  474. String: opfdStack.Pop().(efp.Token).TValue,
  475. Type: ArgString,
  476. })
  477. }
  478. // call formula function to evaluate
  479. arg := callFuncByName(&formulaFuncs{}, strings.NewReplacer(
  480. "_xlfn", "", ".", "").Replace(opfStack.Peek().(efp.Token).TValue),
  481. []reflect.Value{reflect.ValueOf(argsStack.Peek().(*list.List))})
  482. if arg.Type == ArgError {
  483. return errors.New(arg.Value())
  484. }
  485. argsStack.Pop()
  486. opfStack.Pop()
  487. if opfStack.Len() > 0 { // still in function stack
  488. if nextToken.TType == efp.TokenTypeOperatorInfix {
  489. // mathematics calculate in formula function
  490. opfdStack.Push(efp.Token{TValue: arg.Value(), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  491. } else {
  492. argsStack.Peek().(*list.List).PushBack(arg)
  493. }
  494. } else {
  495. opdStack.Push(efp.Token{TValue: arg.Value(), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  496. }
  497. return nil
  498. }
  499. // calcPow evaluate exponentiation arithmetic operations.
  500. func calcPow(rOpd, lOpd string, opdStack *Stack) error {
  501. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  502. if err != nil {
  503. return err
  504. }
  505. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  506. if err != nil {
  507. return err
  508. }
  509. result := math.Pow(lOpdVal, rOpdVal)
  510. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  511. return nil
  512. }
  513. // calcEq evaluate equal arithmetic operations.
  514. func calcEq(rOpd, lOpd string, opdStack *Stack) error {
  515. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpd == lOpd)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  516. return nil
  517. }
  518. // calcNEq evaluate not equal arithmetic operations.
  519. func calcNEq(rOpd, lOpd string, opdStack *Stack) error {
  520. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpd != lOpd)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  521. return nil
  522. }
  523. // calcL evaluate less than arithmetic operations.
  524. func calcL(rOpd, lOpd string, opdStack *Stack) error {
  525. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  526. if err != nil {
  527. return err
  528. }
  529. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  530. if err != nil {
  531. return err
  532. }
  533. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpdVal > lOpdVal)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  534. return nil
  535. }
  536. // calcLe evaluate less than or equal arithmetic operations.
  537. func calcLe(rOpd, lOpd string, opdStack *Stack) error {
  538. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  539. if err != nil {
  540. return err
  541. }
  542. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  543. if err != nil {
  544. return err
  545. }
  546. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpdVal >= lOpdVal)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  547. return nil
  548. }
  549. // calcG evaluate greater than or equal arithmetic operations.
  550. func calcG(rOpd, lOpd string, opdStack *Stack) error {
  551. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  552. if err != nil {
  553. return err
  554. }
  555. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  556. if err != nil {
  557. return err
  558. }
  559. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpdVal < lOpdVal)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  560. return nil
  561. }
  562. // calcGe evaluate greater than or equal arithmetic operations.
  563. func calcGe(rOpd, lOpd string, opdStack *Stack) error {
  564. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  565. if err != nil {
  566. return err
  567. }
  568. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  569. if err != nil {
  570. return err
  571. }
  572. opdStack.Push(efp.Token{TValue: strings.ToUpper(strconv.FormatBool(rOpdVal <= lOpdVal)), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  573. return nil
  574. }
  575. // calcSplice evaluate splice '&' operations.
  576. func calcSplice(rOpd, lOpd string, opdStack *Stack) error {
  577. opdStack.Push(efp.Token{TValue: lOpd + rOpd, TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  578. return nil
  579. }
  580. // calcAdd evaluate addition arithmetic operations.
  581. func calcAdd(rOpd, lOpd string, opdStack *Stack) error {
  582. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  583. if err != nil {
  584. return err
  585. }
  586. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  587. if err != nil {
  588. return err
  589. }
  590. result := lOpdVal + rOpdVal
  591. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  592. return nil
  593. }
  594. // calcSubtract evaluate subtraction arithmetic operations.
  595. func calcSubtract(rOpd, lOpd string, opdStack *Stack) error {
  596. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  597. if err != nil {
  598. return err
  599. }
  600. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  601. if err != nil {
  602. return err
  603. }
  604. result := lOpdVal - rOpdVal
  605. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  606. return nil
  607. }
  608. // calcMultiply evaluate multiplication arithmetic operations.
  609. func calcMultiply(rOpd, lOpd string, opdStack *Stack) error {
  610. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  611. if err != nil {
  612. return err
  613. }
  614. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  615. if err != nil {
  616. return err
  617. }
  618. result := lOpdVal * rOpdVal
  619. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  620. return nil
  621. }
  622. // calcDiv evaluate division arithmetic operations.
  623. func calcDiv(rOpd, lOpd string, opdStack *Stack) error {
  624. lOpdVal, err := strconv.ParseFloat(lOpd, 64)
  625. if err != nil {
  626. return err
  627. }
  628. rOpdVal, err := strconv.ParseFloat(rOpd, 64)
  629. if err != nil {
  630. return err
  631. }
  632. result := lOpdVal / rOpdVal
  633. if rOpdVal == 0 {
  634. return errors.New(formulaErrorDIV)
  635. }
  636. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  637. return nil
  638. }
  639. // calculate evaluate basic arithmetic operations.
  640. func calculate(opdStack *Stack, opt efp.Token) error {
  641. if opt.TValue == "-" && opt.TType == efp.TokenTypeOperatorPrefix {
  642. if opdStack.Len() < 1 {
  643. return errors.New("formula not valid")
  644. }
  645. opd := opdStack.Pop().(efp.Token)
  646. opdVal, err := strconv.ParseFloat(opd.TValue, 64)
  647. if err != nil {
  648. return err
  649. }
  650. result := 0 - opdVal
  651. opdStack.Push(efp.Token{TValue: fmt.Sprintf("%g", result), TType: efp.TokenTypeOperand, TSubType: efp.TokenSubTypeNumber})
  652. }
  653. tokenCalcFunc := map[string]func(rOpd, lOpd string, opdStack *Stack) error{
  654. "^": calcPow,
  655. "*": calcMultiply,
  656. "/": calcDiv,
  657. "+": calcAdd,
  658. "=": calcEq,
  659. "<>": calcNEq,
  660. "<": calcL,
  661. "<=": calcLe,
  662. ">": calcG,
  663. ">=": calcGe,
  664. "&": calcSplice,
  665. }
  666. if opt.TValue == "-" && opt.TType == efp.TokenTypeOperatorInfix {
  667. if opdStack.Len() < 2 {
  668. return errors.New("formula not valid")
  669. }
  670. rOpd := opdStack.Pop().(efp.Token)
  671. lOpd := opdStack.Pop().(efp.Token)
  672. if err := calcSubtract(rOpd.TValue, lOpd.TValue, opdStack); err != nil {
  673. return err
  674. }
  675. }
  676. fn, ok := tokenCalcFunc[opt.TValue]
  677. if ok {
  678. if opdStack.Len() < 2 {
  679. return errors.New("formula not valid")
  680. }
  681. rOpd := opdStack.Pop().(efp.Token)
  682. lOpd := opdStack.Pop().(efp.Token)
  683. if err := fn(rOpd.TValue, lOpd.TValue, opdStack); err != nil {
  684. return err
  685. }
  686. }
  687. return nil
  688. }
  689. // parseOperatorPrefixToken parse operator prefix token.
  690. func (f *File) parseOperatorPrefixToken(optStack, opdStack *Stack, token efp.Token) (err error) {
  691. if optStack.Len() == 0 {
  692. optStack.Push(token)
  693. } else {
  694. tokenPriority := getPriority(token)
  695. topOpt := optStack.Peek().(efp.Token)
  696. topOptPriority := getPriority(topOpt)
  697. if tokenPriority > topOptPriority {
  698. optStack.Push(token)
  699. } else {
  700. for tokenPriority <= topOptPriority {
  701. optStack.Pop()
  702. if err = calculate(opdStack, topOpt); err != nil {
  703. return
  704. }
  705. if optStack.Len() > 0 {
  706. topOpt = optStack.Peek().(efp.Token)
  707. topOptPriority = getPriority(topOpt)
  708. continue
  709. }
  710. break
  711. }
  712. optStack.Push(token)
  713. }
  714. }
  715. return
  716. }
  717. // isFunctionStartToken determine if the token is function stop.
  718. func isFunctionStartToken(token efp.Token) bool {
  719. return token.TType == efp.TokenTypeFunction && token.TSubType == efp.TokenSubTypeStart
  720. }
  721. // isFunctionStopToken determine if the token is function stop.
  722. func isFunctionStopToken(token efp.Token) bool {
  723. return token.TType == efp.TokenTypeFunction && token.TSubType == efp.TokenSubTypeStop
  724. }
  725. // isBeginParenthesesToken determine if the token is begin parentheses: (.
  726. func isBeginParenthesesToken(token efp.Token) bool {
  727. return token.TType == efp.TokenTypeSubexpression && token.TSubType == efp.TokenSubTypeStart
  728. }
  729. // isEndParenthesesToken determine if the token is end parentheses: ).
  730. func isEndParenthesesToken(token efp.Token) bool {
  731. return token.TType == efp.TokenTypeSubexpression && token.TSubType == efp.TokenSubTypeStop
  732. }
  733. // isOperatorPrefixToken determine if the token is parse operator prefix
  734. // token.
  735. func isOperatorPrefixToken(token efp.Token) bool {
  736. _, ok := tokenPriority[token.TValue]
  737. if (token.TValue == "-" && token.TType == efp.TokenTypeOperatorPrefix) || ok {
  738. return true
  739. }
  740. return false
  741. }
  742. // getDefinedNameRefTo convert defined name to reference range.
  743. func (f *File) getDefinedNameRefTo(definedNameName string, currentSheet string) (refTo string) {
  744. for _, definedName := range f.GetDefinedName() {
  745. if definedName.Name == definedNameName {
  746. refTo = definedName.RefersTo
  747. // worksheet scope takes precedence over scope workbook when both definedNames exist
  748. if definedName.Scope == currentSheet {
  749. break
  750. }
  751. }
  752. }
  753. return refTo
  754. }
  755. // parseToken parse basic arithmetic operator priority and evaluate based on
  756. // operators and operands.
  757. func (f *File) parseToken(sheet string, token efp.Token, opdStack, optStack *Stack) error {
  758. // parse reference: must reference at here
  759. if token.TSubType == efp.TokenSubTypeRange {
  760. refTo := f.getDefinedNameRefTo(token.TValue, sheet)
  761. if refTo != "" {
  762. token.TValue = refTo
  763. }
  764. result, err := f.parseReference(sheet, token.TValue)
  765. if err != nil {
  766. return errors.New(formulaErrorNAME)
  767. }
  768. if result.Type != ArgString {
  769. return errors.New(formulaErrorVALUE)
  770. }
  771. token.TValue = result.String
  772. token.TType = efp.TokenTypeOperand
  773. token.TSubType = efp.TokenSubTypeNumber
  774. }
  775. if isOperatorPrefixToken(token) {
  776. if err := f.parseOperatorPrefixToken(optStack, opdStack, token); err != nil {
  777. return err
  778. }
  779. }
  780. if isBeginParenthesesToken(token) { // (
  781. optStack.Push(token)
  782. }
  783. if isEndParenthesesToken(token) { // )
  784. for !isBeginParenthesesToken(optStack.Peek().(efp.Token)) { // != (
  785. topOpt := optStack.Peek().(efp.Token)
  786. if err := calculate(opdStack, topOpt); err != nil {
  787. return err
  788. }
  789. optStack.Pop()
  790. }
  791. optStack.Pop()
  792. }
  793. // opd
  794. if token.TType == efp.TokenTypeOperand && token.TSubType == efp.TokenSubTypeNumber {
  795. opdStack.Push(token)
  796. }
  797. return nil
  798. }
  799. // parseReference parse reference and extract values by given reference
  800. // characters and default sheet name.
  801. func (f *File) parseReference(sheet, reference string) (arg formulaArg, err error) {
  802. reference = strings.Replace(reference, "$", "", -1)
  803. refs, cellRanges, cellRefs := list.New(), list.New(), list.New()
  804. for _, ref := range strings.Split(reference, ":") {
  805. tokens := strings.Split(ref, "!")
  806. cr := cellRef{}
  807. if len(tokens) == 2 { // have a worksheet name
  808. cr.Sheet = tokens[0]
  809. if cr.Col, cr.Row, err = CellNameToCoordinates(tokens[1]); err != nil {
  810. return
  811. }
  812. if refs.Len() > 0 {
  813. e := refs.Back()
  814. cellRefs.PushBack(e.Value.(cellRef))
  815. refs.Remove(e)
  816. }
  817. refs.PushBack(cr)
  818. continue
  819. }
  820. if cr.Col, cr.Row, err = CellNameToCoordinates(tokens[0]); err != nil {
  821. if cr.Col, err = ColumnNameToNumber(tokens[0]); err != nil {
  822. return
  823. }
  824. cellRanges.PushBack(cellRange{
  825. From: cellRef{Sheet: sheet, Col: cr.Col, Row: 1},
  826. To: cellRef{Sheet: sheet, Col: cr.Col, Row: TotalRows},
  827. })
  828. cellRefs.Init()
  829. arg, err = f.rangeResolver(cellRefs, cellRanges)
  830. return
  831. }
  832. e := refs.Back()
  833. if e == nil {
  834. cr.Sheet = sheet
  835. refs.PushBack(cr)
  836. continue
  837. }
  838. cellRanges.PushBack(cellRange{
  839. From: e.Value.(cellRef),
  840. To: cr,
  841. })
  842. refs.Remove(e)
  843. }
  844. if refs.Len() > 0 {
  845. e := refs.Back()
  846. cellRefs.PushBack(e.Value.(cellRef))
  847. refs.Remove(e)
  848. }
  849. arg, err = f.rangeResolver(cellRefs, cellRanges)
  850. return
  851. }
  852. // prepareValueRange prepare value range.
  853. func prepareValueRange(cr cellRange, valueRange []int) {
  854. if cr.From.Row < valueRange[0] || valueRange[0] == 0 {
  855. valueRange[0] = cr.From.Row
  856. }
  857. if cr.From.Col < valueRange[2] || valueRange[2] == 0 {
  858. valueRange[2] = cr.From.Col
  859. }
  860. if cr.To.Row > valueRange[1] || valueRange[1] == 0 {
  861. valueRange[1] = cr.To.Row
  862. }
  863. if cr.To.Col > valueRange[3] || valueRange[3] == 0 {
  864. valueRange[3] = cr.To.Col
  865. }
  866. }
  867. // prepareValueRef prepare value reference.
  868. func prepareValueRef(cr cellRef, valueRange []int) {
  869. if cr.Row < valueRange[0] || valueRange[0] == 0 {
  870. valueRange[0] = cr.Row
  871. }
  872. if cr.Col < valueRange[2] || valueRange[2] == 0 {
  873. valueRange[2] = cr.Col
  874. }
  875. if cr.Row > valueRange[1] || valueRange[1] == 0 {
  876. valueRange[1] = cr.Row
  877. }
  878. if cr.Col > valueRange[3] || valueRange[3] == 0 {
  879. valueRange[3] = cr.Col
  880. }
  881. }
  882. // rangeResolver extract value as string from given reference and range list.
  883. // This function will not ignore the empty cell. For example, A1:A2:A2:B3 will
  884. // be reference A1:B3.
  885. func (f *File) rangeResolver(cellRefs, cellRanges *list.List) (arg formulaArg, err error) {
  886. // value range order: from row, to row, from column, to column
  887. valueRange := []int{0, 0, 0, 0}
  888. var sheet string
  889. // prepare value range
  890. for temp := cellRanges.Front(); temp != nil; temp = temp.Next() {
  891. cr := temp.Value.(cellRange)
  892. if cr.From.Sheet != cr.To.Sheet {
  893. err = errors.New(formulaErrorVALUE)
  894. }
  895. rng := []int{cr.From.Col, cr.From.Row, cr.To.Col, cr.To.Row}
  896. sortCoordinates(rng)
  897. cr.From.Col, cr.From.Row, cr.To.Col, cr.To.Row = rng[0], rng[1], rng[2], rng[3]
  898. prepareValueRange(cr, valueRange)
  899. if cr.From.Sheet != "" {
  900. sheet = cr.From.Sheet
  901. }
  902. }
  903. for temp := cellRefs.Front(); temp != nil; temp = temp.Next() {
  904. cr := temp.Value.(cellRef)
  905. if cr.Sheet != "" {
  906. sheet = cr.Sheet
  907. }
  908. prepareValueRef(cr, valueRange)
  909. }
  910. // extract value from ranges
  911. if cellRanges.Len() > 0 {
  912. arg.Type = ArgMatrix
  913. for row := valueRange[0]; row <= valueRange[1]; row++ {
  914. var matrixRow = []formulaArg{}
  915. for col := valueRange[2]; col <= valueRange[3]; col++ {
  916. var cell, value string
  917. if cell, err = CoordinatesToCellName(col, row); err != nil {
  918. return
  919. }
  920. if value, err = f.GetCellValue(sheet, cell); err != nil {
  921. return
  922. }
  923. matrixRow = append(matrixRow, formulaArg{
  924. String: value,
  925. Type: ArgString,
  926. })
  927. }
  928. arg.Matrix = append(arg.Matrix, matrixRow)
  929. }
  930. return
  931. }
  932. // extract value from references
  933. for temp := cellRefs.Front(); temp != nil; temp = temp.Next() {
  934. cr := temp.Value.(cellRef)
  935. var cell string
  936. if cell, err = CoordinatesToCellName(cr.Col, cr.Row); err != nil {
  937. return
  938. }
  939. if arg.String, err = f.GetCellValue(cr.Sheet, cell); err != nil {
  940. return
  941. }
  942. arg.Type = ArgString
  943. }
  944. return
  945. }
  946. // callFuncByName calls the no error or only error return function with
  947. // reflect by given receiver, name and parameters.
  948. func callFuncByName(receiver interface{}, name string, params []reflect.Value) (arg formulaArg) {
  949. function := reflect.ValueOf(receiver).MethodByName(name)
  950. if function.IsValid() {
  951. rt := function.Call(params)
  952. if len(rt) == 0 {
  953. return
  954. }
  955. arg = rt[0].Interface().(formulaArg)
  956. return
  957. }
  958. return newErrorFormulaArg(formulaErrorVALUE, fmt.Sprintf("not support %s function", name))
  959. }
  960. // formulaCriteriaParser parse formula criteria.
  961. func formulaCriteriaParser(exp string) (fc *formulaCriteria) {
  962. fc = &formulaCriteria{}
  963. if exp == "" {
  964. return
  965. }
  966. if match := regexp.MustCompile(`^([0-9]+)$`).FindStringSubmatch(exp); len(match) > 1 {
  967. fc.Type, fc.Condition = criteriaEq, match[1]
  968. return
  969. }
  970. if match := regexp.MustCompile(`^=(.*)$`).FindStringSubmatch(exp); len(match) > 1 {
  971. fc.Type, fc.Condition = criteriaEq, match[1]
  972. return
  973. }
  974. if match := regexp.MustCompile(`^<=(.*)$`).FindStringSubmatch(exp); len(match) > 1 {
  975. fc.Type, fc.Condition = criteriaLe, match[1]
  976. return
  977. }
  978. if match := regexp.MustCompile(`^>=(.*)$`).FindStringSubmatch(exp); len(match) > 1 {
  979. fc.Type, fc.Condition = criteriaGe, match[1]
  980. return
  981. }
  982. if match := regexp.MustCompile(`^<(.*)$`).FindStringSubmatch(exp); len(match) > 1 {
  983. fc.Type, fc.Condition = criteriaL, match[1]
  984. return
  985. }
  986. if match := regexp.MustCompile(`^>(.*)$`).FindStringSubmatch(exp); len(match) > 1 {
  987. fc.Type, fc.Condition = criteriaG, match[1]
  988. return
  989. }
  990. if strings.Contains(exp, "*") {
  991. if strings.HasPrefix(exp, "*") {
  992. fc.Type, fc.Condition = criteriaEnd, strings.TrimPrefix(exp, "*")
  993. }
  994. if strings.HasSuffix(exp, "*") {
  995. fc.Type, fc.Condition = criteriaBeg, strings.TrimSuffix(exp, "*")
  996. }
  997. return
  998. }
  999. fc.Type, fc.Condition = criteriaEq, exp
  1000. return
  1001. }
  1002. // formulaCriteriaEval evaluate formula criteria expression.
  1003. func formulaCriteriaEval(val string, criteria *formulaCriteria) (result bool, err error) {
  1004. var value, expected float64
  1005. var e error
  1006. var prepareValue = func(val, cond string) (value float64, expected float64, err error) {
  1007. if value, err = strconv.ParseFloat(val, 64); err != nil {
  1008. return
  1009. }
  1010. if expected, err = strconv.ParseFloat(criteria.Condition, 64); err != nil {
  1011. return
  1012. }
  1013. return
  1014. }
  1015. switch criteria.Type {
  1016. case criteriaEq:
  1017. return val == criteria.Condition, err
  1018. case criteriaLe:
  1019. value, expected, e = prepareValue(val, criteria.Condition)
  1020. return value <= expected && e == nil, err
  1021. case criteriaGe:
  1022. value, expected, e = prepareValue(val, criteria.Condition)
  1023. return value >= expected && e == nil, err
  1024. case criteriaL:
  1025. value, expected, e = prepareValue(val, criteria.Condition)
  1026. return value < expected && e == nil, err
  1027. case criteriaG:
  1028. value, expected, e = prepareValue(val, criteria.Condition)
  1029. return value > expected && e == nil, err
  1030. case criteriaBeg:
  1031. return strings.HasPrefix(val, criteria.Condition), err
  1032. case criteriaEnd:
  1033. return strings.HasSuffix(val, criteria.Condition), err
  1034. }
  1035. return
  1036. }
  1037. // Math and Trigonometric functions
  1038. // ABS function returns the absolute value of any supplied number. The syntax
  1039. // of the function is:
  1040. //
  1041. // ABS(number)
  1042. //
  1043. func (fn *formulaFuncs) ABS(argsList *list.List) formulaArg {
  1044. if argsList.Len() != 1 {
  1045. return newErrorFormulaArg(formulaErrorVALUE, "ABS requires 1 numeric argument")
  1046. }
  1047. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1048. if arg.Type == ArgError {
  1049. return arg
  1050. }
  1051. return newNumberFormulaArg(math.Abs(arg.Number))
  1052. }
  1053. // ACOS function calculates the arccosine (i.e. the inverse cosine) of a given
  1054. // number, and returns an angle, in radians, between 0 and π. The syntax of
  1055. // the function is:
  1056. //
  1057. // ACOS(number)
  1058. //
  1059. func (fn *formulaFuncs) ACOS(argsList *list.List) formulaArg {
  1060. if argsList.Len() != 1 {
  1061. return newErrorFormulaArg(formulaErrorVALUE, "ACOS requires 1 numeric argument")
  1062. }
  1063. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1064. if arg.Type == ArgError {
  1065. return arg
  1066. }
  1067. return newNumberFormulaArg(math.Acos(arg.Number))
  1068. }
  1069. // ACOSH function calculates the inverse hyperbolic cosine of a supplied number.
  1070. // of the function is:
  1071. //
  1072. // ACOSH(number)
  1073. //
  1074. func (fn *formulaFuncs) ACOSH(argsList *list.List) formulaArg {
  1075. if argsList.Len() != 1 {
  1076. return newErrorFormulaArg(formulaErrorVALUE, "ACOSH requires 1 numeric argument")
  1077. }
  1078. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1079. if arg.Type == ArgError {
  1080. return arg
  1081. }
  1082. return newNumberFormulaArg(math.Acosh(arg.Number))
  1083. }
  1084. // ACOT function calculates the arccotangent (i.e. the inverse cotangent) of a
  1085. // given number, and returns an angle, in radians, between 0 and π. The syntax
  1086. // of the function is:
  1087. //
  1088. // ACOT(number)
  1089. //
  1090. func (fn *formulaFuncs) ACOT(argsList *list.List) formulaArg {
  1091. if argsList.Len() != 1 {
  1092. return newErrorFormulaArg(formulaErrorVALUE, "ACOT requires 1 numeric argument")
  1093. }
  1094. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1095. if arg.Type == ArgError {
  1096. return arg
  1097. }
  1098. return newNumberFormulaArg(math.Pi/2 - math.Atan(arg.Number))
  1099. }
  1100. // ACOTH function calculates the hyperbolic arccotangent (coth) of a supplied
  1101. // value. The syntax of the function is:
  1102. //
  1103. // ACOTH(number)
  1104. //
  1105. func (fn *formulaFuncs) ACOTH(argsList *list.List) formulaArg {
  1106. if argsList.Len() != 1 {
  1107. return newErrorFormulaArg(formulaErrorVALUE, "ACOTH requires 1 numeric argument")
  1108. }
  1109. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1110. if arg.Type == ArgError {
  1111. return arg
  1112. }
  1113. return newNumberFormulaArg(math.Atanh(1 / arg.Number))
  1114. }
  1115. // ARABIC function converts a Roman numeral into an Arabic numeral. The syntax
  1116. // of the function is:
  1117. //
  1118. // ARABIC(text)
  1119. //
  1120. func (fn *formulaFuncs) ARABIC(argsList *list.List) formulaArg {
  1121. if argsList.Len() != 1 {
  1122. return newErrorFormulaArg(formulaErrorVALUE, "ARABIC requires 1 numeric argument")
  1123. }
  1124. charMap := map[rune]float64{'I': 1, 'V': 5, 'X': 10, 'L': 50, 'C': 100, 'D': 500, 'M': 1000}
  1125. val, last, prefix := 0.0, 0.0, 1.0
  1126. for _, char := range argsList.Front().Value.(formulaArg).String {
  1127. digit := 0.0
  1128. if char == '-' {
  1129. prefix = -1
  1130. continue
  1131. }
  1132. digit, _ = charMap[char]
  1133. val += digit
  1134. switch {
  1135. case last == digit && (last == 5 || last == 50 || last == 500):
  1136. return newErrorFormulaArg(formulaErrorVALUE, formulaErrorVALUE)
  1137. case 2*last == digit:
  1138. return newErrorFormulaArg(formulaErrorVALUE, formulaErrorVALUE)
  1139. }
  1140. if last < digit {
  1141. val -= 2 * last
  1142. }
  1143. last = digit
  1144. }
  1145. return newNumberFormulaArg(prefix * val)
  1146. }
  1147. // ASIN function calculates the arcsine (i.e. the inverse sine) of a given
  1148. // number, and returns an angle, in radians, between -π/2 and π/2. The syntax
  1149. // of the function is:
  1150. //
  1151. // ASIN(number)
  1152. //
  1153. func (fn *formulaFuncs) ASIN(argsList *list.List) formulaArg {
  1154. if argsList.Len() != 1 {
  1155. return newErrorFormulaArg(formulaErrorVALUE, "ASIN requires 1 numeric argument")
  1156. }
  1157. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1158. if arg.Type == ArgError {
  1159. return arg
  1160. }
  1161. return newNumberFormulaArg(math.Asin(arg.Number))
  1162. }
  1163. // ASINH function calculates the inverse hyperbolic sine of a supplied number.
  1164. // The syntax of the function is:
  1165. //
  1166. // ASINH(number)
  1167. //
  1168. func (fn *formulaFuncs) ASINH(argsList *list.List) formulaArg {
  1169. if argsList.Len() != 1 {
  1170. return newErrorFormulaArg(formulaErrorVALUE, "ASINH requires 1 numeric argument")
  1171. }
  1172. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1173. if arg.Type == ArgError {
  1174. return arg
  1175. }
  1176. return newNumberFormulaArg(math.Asinh(arg.Number))
  1177. }
  1178. // ATAN function calculates the arctangent (i.e. the inverse tangent) of a
  1179. // given number, and returns an angle, in radians, between -π/2 and +π/2. The
  1180. // syntax of the function is:
  1181. //
  1182. // ATAN(number)
  1183. //
  1184. func (fn *formulaFuncs) ATAN(argsList *list.List) formulaArg {
  1185. if argsList.Len() != 1 {
  1186. return newErrorFormulaArg(formulaErrorVALUE, "ATAN requires 1 numeric argument")
  1187. }
  1188. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1189. if arg.Type == ArgError {
  1190. return arg
  1191. }
  1192. return newNumberFormulaArg(math.Atan(arg.Number))
  1193. }
  1194. // ATANH function calculates the inverse hyperbolic tangent of a supplied
  1195. // number. The syntax of the function is:
  1196. //
  1197. // ATANH(number)
  1198. //
  1199. func (fn *formulaFuncs) ATANH(argsList *list.List) formulaArg {
  1200. if argsList.Len() != 1 {
  1201. return newErrorFormulaArg(formulaErrorVALUE, "ATANH requires 1 numeric argument")
  1202. }
  1203. arg := argsList.Front().Value.(formulaArg).ToNumber()
  1204. if arg.Type == ArgError {
  1205. return arg
  1206. }
  1207. return newNumberFormulaArg(math.Atanh(arg.Number))
  1208. }
  1209. // ATAN2 function calculates the arctangent (i.e. the inverse tangent) of a
  1210. // given set of x and y coordinates, and returns an angle, in radians, between
  1211. // -π/2 and +π/2. The syntax of the function is:
  1212. //
  1213. // ATAN2(x_num,y_num)
  1214. //
  1215. func (fn *formulaFuncs) ATAN2(argsList *list.List) formulaArg {
  1216. if argsList.Len() != 2 {
  1217. return newErrorFormulaArg(formulaErrorVALUE, "ATAN2 requires 2 numeric arguments")
  1218. }
  1219. x := argsList.Back().Value.(formulaArg).ToNumber()
  1220. if x.Type == ArgError {
  1221. return x
  1222. }
  1223. y := argsList.Front().Value.(formulaArg).ToNumber()
  1224. if y.Type == ArgError {
  1225. return y
  1226. }
  1227. return newNumberFormulaArg(math.Atan2(x.Number, y.Number))
  1228. }
  1229. // BASE function converts a number into a supplied base (radix), and returns a
  1230. // text representation of the calculated value. The syntax of the function is:
  1231. //
  1232. // BASE(number,radix,[min_length])
  1233. //
  1234. func (fn *formulaFuncs) BASE(argsList *list.List) formulaArg {
  1235. if argsList.Len() < 2 {
  1236. return newErrorFormulaArg(formulaErrorVALUE, "BASE requires at least 2 arguments")
  1237. }
  1238. if argsList.Len() > 3 {
  1239. return newErrorFormulaArg(formulaErrorVALUE, "BASE allows at most 3 arguments")
  1240. }
  1241. var minLength int
  1242. var err error
  1243. number := argsList.Front().Value.(formulaArg).ToNumber()
  1244. if number.Type == ArgError {
  1245. return number
  1246. }
  1247. radix := argsList.Front().Next().Value.(formulaArg).ToNumber()
  1248. if radix.Type == ArgError {
  1249. return radix
  1250. }
  1251. if int(radix.Number) < 2 || int(radix.Number) > 36 {
  1252. return newErrorFormulaArg(formulaErrorVALUE, "radix must be an integer >= 2 and <= 36")
  1253. }
  1254. if argsList.Len() > 2 {
  1255. if minLength, err = strconv.Atoi(argsList.Back().Value.(formulaArg).String); err != nil {
  1256. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  1257. }
  1258. }
  1259. result := strconv.FormatInt(int64(number.Number), int(radix.Number))
  1260. if len(result) < minLength {
  1261. result = strings.Repeat("0", minLength-len(result)) + result
  1262. }
  1263. return newStringFormulaArg(strings.ToUpper(result))
  1264. }
  1265. // CEILING function rounds a supplied number away from zero, to the nearest
  1266. // multiple of a given number. The syntax of the function is:
  1267. //
  1268. // CEILING(number,significance)
  1269. //
  1270. func (fn *formulaFuncs) CEILING(argsList *list.List) formulaArg {
  1271. if argsList.Len() == 0 {
  1272. return newErrorFormulaArg(formulaErrorVALUE, "CEILING requires at least 1 argument")
  1273. }
  1274. if argsList.Len() > 2 {
  1275. return newErrorFormulaArg(formulaErrorVALUE, "CEILING allows at most 2 arguments")
  1276. }
  1277. number, significance, res := 0.0, 1.0, 0.0
  1278. n := argsList.Front().Value.(formulaArg).ToNumber()
  1279. if n.Type == ArgError {
  1280. return n
  1281. }
  1282. number = n.Number
  1283. if number < 0 {
  1284. significance = -1
  1285. }
  1286. if argsList.Len() > 1 {
  1287. s := argsList.Back().Value.(formulaArg).ToNumber()
  1288. if s.Type == ArgError {
  1289. return s
  1290. }
  1291. significance = s.Number
  1292. }
  1293. if significance < 0 && number > 0 {
  1294. return newErrorFormulaArg(formulaErrorVALUE, "negative sig to CEILING invalid")
  1295. }
  1296. if argsList.Len() == 1 {
  1297. return newNumberFormulaArg(math.Ceil(number))
  1298. }
  1299. number, res = math.Modf(number / significance)
  1300. if res > 0 {
  1301. number++
  1302. }
  1303. return newNumberFormulaArg(number * significance)
  1304. }
  1305. // CEILINGMATH function rounds a supplied number up to a supplied multiple of
  1306. // significance. The syntax of the function is:
  1307. //
  1308. // CEILING.MATH(number,[significance],[mode])
  1309. //
  1310. func (fn *formulaFuncs) CEILINGMATH(argsList *list.List) formulaArg {
  1311. if argsList.Len() == 0 {
  1312. return newErrorFormulaArg(formulaErrorVALUE, "CEILING.MATH requires at least 1 argument")
  1313. }
  1314. if argsList.Len() > 3 {
  1315. return newErrorFormulaArg(formulaErrorVALUE, "CEILING.MATH allows at most 3 arguments")
  1316. }
  1317. number, significance, mode := 0.0, 1.0, 1.0
  1318. n := argsList.Front().Value.(formulaArg).ToNumber()
  1319. if n.Type == ArgError {
  1320. return n
  1321. }
  1322. number = n.Number
  1323. if number < 0 {
  1324. significance = -1
  1325. }
  1326. if argsList.Len() > 1 {
  1327. s := argsList.Front().Next().Value.(formulaArg).ToNumber()
  1328. if s.Type == ArgError {
  1329. return s
  1330. }
  1331. significance = s.Number
  1332. }
  1333. if argsList.Len() == 1 {
  1334. return newNumberFormulaArg(math.Ceil(number))
  1335. }
  1336. if argsList.Len() > 2 {
  1337. m := argsList.Back().Value.(formulaArg).ToNumber()
  1338. if m.Type == ArgError {
  1339. return m
  1340. }
  1341. mode = m.Number
  1342. }
  1343. val, res := math.Modf(number / significance)
  1344. if res != 0 {
  1345. if number > 0 {
  1346. val++
  1347. } else if mode < 0 {
  1348. val--
  1349. }
  1350. }
  1351. return newNumberFormulaArg(val * significance)
  1352. }
  1353. // CEILINGPRECISE function rounds a supplied number up (regardless of the
  1354. // number's sign), to the nearest multiple of a given number. The syntax of
  1355. // the function is:
  1356. //
  1357. // CEILING.PRECISE(number,[significance])
  1358. //
  1359. func (fn *formulaFuncs) CEILINGPRECISE(argsList *list.List) formulaArg {
  1360. if argsList.Len() == 0 {
  1361. return newErrorFormulaArg(formulaErrorVALUE, "CEILING.PRECISE requires at least 1 argument")
  1362. }
  1363. if argsList.Len() > 2 {
  1364. return newErrorFormulaArg(formulaErrorVALUE, "CEILING.PRECISE allows at most 2 arguments")
  1365. }
  1366. number, significance := 0.0, 1.0
  1367. n := argsList.Front().Value.(formulaArg).ToNumber()
  1368. if n.Type == ArgError {
  1369. return n
  1370. }
  1371. number = n.Number
  1372. if number < 0 {
  1373. significance = -1
  1374. }
  1375. if argsList.Len() == 1 {
  1376. return newNumberFormulaArg(math.Ceil(number))
  1377. }
  1378. if argsList.Len() > 1 {
  1379. s := argsList.Back().Value.(formulaArg).ToNumber()
  1380. if s.Type == ArgError {
  1381. return s
  1382. }
  1383. significance = s.Number
  1384. significance = math.Abs(significance)
  1385. if significance == 0 {
  1386. return newNumberFormulaArg(significance)
  1387. }
  1388. }
  1389. val, res := math.Modf(number / significance)
  1390. if res != 0 {
  1391. if number > 0 {
  1392. val++
  1393. }
  1394. }
  1395. return newNumberFormulaArg(val * significance)
  1396. }
  1397. // COMBIN function calculates the number of combinations (in any order) of a
  1398. // given number objects from a set. The syntax of the function is:
  1399. //
  1400. // COMBIN(number,number_chosen)
  1401. //
  1402. func (fn *formulaFuncs) COMBIN(argsList *list.List) formulaArg {
  1403. if argsList.Len() != 2 {
  1404. return newErrorFormulaArg(formulaErrorVALUE, "COMBIN requires 2 argument")
  1405. }
  1406. number, chosen, val := 0.0, 0.0, 1.0
  1407. n := argsList.Front().Value.(formulaArg).ToNumber()
  1408. if n.Type == ArgError {
  1409. return n
  1410. }
  1411. number = n.Number
  1412. c := argsList.Back().Value.(formulaArg).ToNumber()
  1413. if c.Type == ArgError {
  1414. return c
  1415. }
  1416. chosen = c.Number
  1417. number, chosen = math.Trunc(number), math.Trunc(chosen)
  1418. if chosen > number {
  1419. return newErrorFormulaArg(formulaErrorVALUE, "COMBIN requires number >= number_chosen")
  1420. }
  1421. if chosen == number || chosen == 0 {
  1422. return newNumberFormulaArg(1)
  1423. }
  1424. for c := float64(1); c <= chosen; c++ {
  1425. val *= (number + 1 - c) / c
  1426. }
  1427. return newNumberFormulaArg(math.Ceil(val))
  1428. }
  1429. // COMBINA function calculates the number of combinations, with repetitions,
  1430. // of a given number objects from a set. The syntax of the function is:
  1431. //
  1432. // COMBINA(number,number_chosen)
  1433. //
  1434. func (fn *formulaFuncs) COMBINA(argsList *list.List) formulaArg {
  1435. if argsList.Len() != 2 {
  1436. return newErrorFormulaArg(formulaErrorVALUE, "COMBINA requires 2 argument")
  1437. }
  1438. var number, chosen float64
  1439. n := argsList.Front().Value.(formulaArg).ToNumber()
  1440. if n.Type == ArgError {
  1441. return n
  1442. }
  1443. number = n.Number
  1444. c := argsList.Back().Value.(formulaArg).ToNumber()
  1445. if c.Type == ArgError {
  1446. return c
  1447. }
  1448. chosen = c.Number
  1449. number, chosen = math.Trunc(number), math.Trunc(chosen)
  1450. if number < chosen {
  1451. return newErrorFormulaArg(formulaErrorVALUE, "COMBINA requires number > number_chosen")
  1452. }
  1453. if number == 0 {
  1454. return newNumberFormulaArg(number)
  1455. }
  1456. args := list.New()
  1457. args.PushBack(formulaArg{
  1458. String: fmt.Sprintf("%g", number+chosen-1),
  1459. Type: ArgString,
  1460. })
  1461. args.PushBack(formulaArg{
  1462. String: fmt.Sprintf("%g", number-1),
  1463. Type: ArgString,
  1464. })
  1465. return fn.COMBIN(args)
  1466. }
  1467. // COS function calculates the cosine of a given angle. The syntax of the
  1468. // function is:
  1469. //
  1470. // COS(number)
  1471. //
  1472. func (fn *formulaFuncs) COS(argsList *list.List) formulaArg {
  1473. if argsList.Len() != 1 {
  1474. return newErrorFormulaArg(formulaErrorVALUE, "COS requires 1 numeric argument")
  1475. }
  1476. val := argsList.Front().Value.(formulaArg).ToNumber()
  1477. if val.Type == ArgError {
  1478. return val
  1479. }
  1480. return newNumberFormulaArg(math.Cos(val.Number))
  1481. }
  1482. // COSH function calculates the hyperbolic cosine (cosh) of a supplied number.
  1483. // The syntax of the function is:
  1484. //
  1485. // COSH(number)
  1486. //
  1487. func (fn *formulaFuncs) COSH(argsList *list.List) formulaArg {
  1488. if argsList.Len() != 1 {
  1489. return newErrorFormulaArg(formulaErrorVALUE, "COSH requires 1 numeric argument")
  1490. }
  1491. val := argsList.Front().Value.(formulaArg).ToNumber()
  1492. if val.Type == ArgError {
  1493. return val
  1494. }
  1495. return newNumberFormulaArg(math.Cosh(val.Number))
  1496. }
  1497. // COT function calculates the cotangent of a given angle. The syntax of the
  1498. // function is:
  1499. //
  1500. // COT(number)
  1501. //
  1502. func (fn *formulaFuncs) COT(argsList *list.List) formulaArg {
  1503. if argsList.Len() != 1 {
  1504. return newErrorFormulaArg(formulaErrorVALUE, "COT requires 1 numeric argument")
  1505. }
  1506. val := argsList.Front().Value.(formulaArg).ToNumber()
  1507. if val.Type == ArgError {
  1508. return val
  1509. }
  1510. if val.Number == 0 {
  1511. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  1512. }
  1513. return newNumberFormulaArg(1 / math.Tan(val.Number))
  1514. }
  1515. // COTH function calculates the hyperbolic cotangent (coth) of a supplied
  1516. // angle. The syntax of the function is:
  1517. //
  1518. // COTH(number)
  1519. //
  1520. func (fn *formulaFuncs) COTH(argsList *list.List) formulaArg {
  1521. if argsList.Len() != 1 {
  1522. return newErrorFormulaArg(formulaErrorVALUE, "COTH requires 1 numeric argument")
  1523. }
  1524. val := argsList.Front().Value.(formulaArg).ToNumber()
  1525. if val.Type == ArgError {
  1526. return val
  1527. }
  1528. if val.Number == 0 {
  1529. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  1530. }
  1531. return newNumberFormulaArg((math.Exp(val.Number) + math.Exp(-val.Number)) / (math.Exp(val.Number) - math.Exp(-val.Number)))
  1532. }
  1533. // CSC function calculates the cosecant of a given angle. The syntax of the
  1534. // function is:
  1535. //
  1536. // CSC(number)
  1537. //
  1538. func (fn *formulaFuncs) CSC(argsList *list.List) formulaArg {
  1539. if argsList.Len() != 1 {
  1540. return newErrorFormulaArg(formulaErrorVALUE, "CSC requires 1 numeric argument")
  1541. }
  1542. val := argsList.Front().Value.(formulaArg).ToNumber()
  1543. if val.Type == ArgError {
  1544. return val
  1545. }
  1546. if val.Number == 0 {
  1547. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  1548. }
  1549. return newNumberFormulaArg(1 / math.Sin(val.Number))
  1550. }
  1551. // CSCH function calculates the hyperbolic cosecant (csch) of a supplied
  1552. // angle. The syntax of the function is:
  1553. //
  1554. // CSCH(number)
  1555. //
  1556. func (fn *formulaFuncs) CSCH(argsList *list.List) formulaArg {
  1557. if argsList.Len() != 1 {
  1558. return newErrorFormulaArg(formulaErrorVALUE, "CSCH requires 1 numeric argument")
  1559. }
  1560. val := argsList.Front().Value.(formulaArg).ToNumber()
  1561. if val.Type == ArgError {
  1562. return val
  1563. }
  1564. if val.Number == 0 {
  1565. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  1566. }
  1567. return newNumberFormulaArg(1 / math.Sinh(val.Number))
  1568. }
  1569. // DECIMAL function converts a text representation of a number in a specified
  1570. // base, into a decimal value. The syntax of the function is:
  1571. //
  1572. // DECIMAL(text,radix)
  1573. //
  1574. func (fn *formulaFuncs) DECIMAL(argsList *list.List) formulaArg {
  1575. if argsList.Len() != 2 {
  1576. return newErrorFormulaArg(formulaErrorVALUE, "DECIMAL requires 2 numeric arguments")
  1577. }
  1578. var text = argsList.Front().Value.(formulaArg).String
  1579. var radix int
  1580. var err error
  1581. radix, err = strconv.Atoi(argsList.Back().Value.(formulaArg).String)
  1582. if err != nil {
  1583. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  1584. }
  1585. if len(text) > 2 && (strings.HasPrefix(text, "0x") || strings.HasPrefix(text, "0X")) {
  1586. text = text[2:]
  1587. }
  1588. val, err := strconv.ParseInt(text, radix, 64)
  1589. if err != nil {
  1590. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  1591. }
  1592. return newNumberFormulaArg(float64(val))
  1593. }
  1594. // DEGREES function converts radians into degrees. The syntax of the function
  1595. // is:
  1596. //
  1597. // DEGREES(angle)
  1598. //
  1599. func (fn *formulaFuncs) DEGREES(argsList *list.List) formulaArg {
  1600. if argsList.Len() != 1 {
  1601. return newErrorFormulaArg(formulaErrorVALUE, "DEGREES requires 1 numeric argument")
  1602. }
  1603. val := argsList.Front().Value.(formulaArg).ToNumber()
  1604. if val.Type == ArgError {
  1605. return val
  1606. }
  1607. if val.Number == 0 {
  1608. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  1609. }
  1610. return newNumberFormulaArg(180.0 / math.Pi * val.Number)
  1611. }
  1612. // EVEN function rounds a supplied number away from zero (i.e. rounds a
  1613. // positive number up and a negative number down), to the next even number.
  1614. // The syntax of the function is:
  1615. //
  1616. // EVEN(number)
  1617. //
  1618. func (fn *formulaFuncs) EVEN(argsList *list.List) formulaArg {
  1619. if argsList.Len() != 1 {
  1620. return newErrorFormulaArg(formulaErrorVALUE, "EVEN requires 1 numeric argument")
  1621. }
  1622. number := argsList.Front().Value.(formulaArg).ToNumber()
  1623. if number.Type == ArgError {
  1624. return number
  1625. }
  1626. sign := math.Signbit(number.Number)
  1627. m, frac := math.Modf(number.Number / 2)
  1628. val := m * 2
  1629. if frac != 0 {
  1630. if !sign {
  1631. val += 2
  1632. } else {
  1633. val -= 2
  1634. }
  1635. }
  1636. return newNumberFormulaArg(val)
  1637. }
  1638. // EXP function calculates the value of the mathematical constant e, raised to
  1639. // the power of a given number. The syntax of the function is:
  1640. //
  1641. // EXP(number)
  1642. //
  1643. func (fn *formulaFuncs) EXP(argsList *list.List) formulaArg {
  1644. if argsList.Len() != 1 {
  1645. return newErrorFormulaArg(formulaErrorVALUE, "EXP requires 1 numeric argument")
  1646. }
  1647. number := argsList.Front().Value.(formulaArg).ToNumber()
  1648. if number.Type == ArgError {
  1649. return number
  1650. }
  1651. return newStringFormulaArg(strings.ToUpper(fmt.Sprintf("%g", math.Exp(number.Number))))
  1652. }
  1653. // fact returns the factorial of a supplied number.
  1654. func fact(number float64) float64 {
  1655. val := float64(1)
  1656. for i := float64(2); i <= number; i++ {
  1657. val *= i
  1658. }
  1659. return val
  1660. }
  1661. // FACT function returns the factorial of a supplied number. The syntax of the
  1662. // function is:
  1663. //
  1664. // FACT(number)
  1665. //
  1666. func (fn *formulaFuncs) FACT(argsList *list.List) formulaArg {
  1667. if argsList.Len() != 1 {
  1668. return newErrorFormulaArg(formulaErrorVALUE, "FACT requires 1 numeric argument")
  1669. }
  1670. number := argsList.Front().Value.(formulaArg).ToNumber()
  1671. if number.Type == ArgError {
  1672. return number
  1673. }
  1674. if number.Number < 0 {
  1675. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  1676. }
  1677. return newStringFormulaArg(strings.ToUpper(fmt.Sprintf("%g", fact(number.Number))))
  1678. }
  1679. // FACTDOUBLE function returns the double factorial of a supplied number. The
  1680. // syntax of the function is:
  1681. //
  1682. // FACTDOUBLE(number)
  1683. //
  1684. func (fn *formulaFuncs) FACTDOUBLE(argsList *list.List) formulaArg {
  1685. if argsList.Len() != 1 {
  1686. return newErrorFormulaArg(formulaErrorVALUE, "FACTDOUBLE requires 1 numeric argument")
  1687. }
  1688. val := 1.0
  1689. number := argsList.Front().Value.(formulaArg).ToNumber()
  1690. if number.Type == ArgError {
  1691. return number
  1692. }
  1693. if number.Number < 0 {
  1694. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  1695. }
  1696. for i := math.Trunc(number.Number); i > 1; i -= 2 {
  1697. val *= i
  1698. }
  1699. return newStringFormulaArg(strings.ToUpper(fmt.Sprintf("%g", val)))
  1700. }
  1701. // FLOOR function rounds a supplied number towards zero to the nearest
  1702. // multiple of a specified significance. The syntax of the function is:
  1703. //
  1704. // FLOOR(number,significance)
  1705. //
  1706. func (fn *formulaFuncs) FLOOR(argsList *list.List) formulaArg {
  1707. if argsList.Len() != 2 {
  1708. return newErrorFormulaArg(formulaErrorVALUE, "FLOOR requires 2 numeric arguments")
  1709. }
  1710. number := argsList.Front().Value.(formulaArg).ToNumber()
  1711. if number.Type == ArgError {
  1712. return number
  1713. }
  1714. significance := argsList.Back().Value.(formulaArg).ToNumber()
  1715. if significance.Type == ArgError {
  1716. return significance
  1717. }
  1718. if significance.Number < 0 && number.Number >= 0 {
  1719. return newErrorFormulaArg(formulaErrorNUM, "invalid arguments to FLOOR")
  1720. }
  1721. val := number.Number
  1722. val, res := math.Modf(val / significance.Number)
  1723. if res != 0 {
  1724. if number.Number < 0 && res < 0 {
  1725. val--
  1726. }
  1727. }
  1728. return newStringFormulaArg(strings.ToUpper(fmt.Sprintf("%g", val*significance.Number)))
  1729. }
  1730. // FLOORMATH function rounds a supplied number down to a supplied multiple of
  1731. // significance. The syntax of the function is:
  1732. //
  1733. // FLOOR.MATH(number,[significance],[mode])
  1734. //
  1735. func (fn *formulaFuncs) FLOORMATH(argsList *list.List) formulaArg {
  1736. if argsList.Len() == 0 {
  1737. return newErrorFormulaArg(formulaErrorVALUE, "FLOOR.MATH requires at least 1 argument")
  1738. }
  1739. if argsList.Len() > 3 {
  1740. return newErrorFormulaArg(formulaErrorVALUE, "FLOOR.MATH allows at most 3 arguments")
  1741. }
  1742. significance, mode := 1.0, 1.0
  1743. number := argsList.Front().Value.(formulaArg).ToNumber()
  1744. if number.Type == ArgError {
  1745. return number
  1746. }
  1747. if number.Number < 0 {
  1748. significance = -1
  1749. }
  1750. if argsList.Len() > 1 {
  1751. s := argsList.Front().Next().Value.(formulaArg).ToNumber()
  1752. if s.Type == ArgError {
  1753. return s
  1754. }
  1755. significance = s.Number
  1756. }
  1757. if argsList.Len() == 1 {
  1758. return newNumberFormulaArg(math.Floor(number.Number))
  1759. }
  1760. if argsList.Len() > 2 {
  1761. m := argsList.Back().Value.(formulaArg).ToNumber()
  1762. if m.Type == ArgError {
  1763. return m
  1764. }
  1765. mode = m.Number
  1766. }
  1767. val, res := math.Modf(number.Number / significance)
  1768. if res != 0 && number.Number < 0 && mode > 0 {
  1769. val--
  1770. }
  1771. return newNumberFormulaArg(val * significance)
  1772. }
  1773. // FLOORPRECISE function rounds a supplied number down to a supplied multiple
  1774. // of significance. The syntax of the function is:
  1775. //
  1776. // FLOOR.PRECISE(number,[significance])
  1777. //
  1778. func (fn *formulaFuncs) FLOORPRECISE(argsList *list.List) formulaArg {
  1779. if argsList.Len() == 0 {
  1780. return newErrorFormulaArg(formulaErrorVALUE, "FLOOR.PRECISE requires at least 1 argument")
  1781. }
  1782. if argsList.Len() > 2 {
  1783. return newErrorFormulaArg(formulaErrorVALUE, "FLOOR.PRECISE allows at most 2 arguments")
  1784. }
  1785. var significance float64
  1786. number := argsList.Front().Value.(formulaArg).ToNumber()
  1787. if number.Type == ArgError {
  1788. return number
  1789. }
  1790. if number.Number < 0 {
  1791. significance = -1
  1792. }
  1793. if argsList.Len() == 1 {
  1794. return newNumberFormulaArg(math.Floor(number.Number))
  1795. }
  1796. if argsList.Len() > 1 {
  1797. s := argsList.Back().Value.(formulaArg).ToNumber()
  1798. if s.Type == ArgError {
  1799. return s
  1800. }
  1801. significance = s.Number
  1802. significance = math.Abs(significance)
  1803. if significance == 0 {
  1804. return newNumberFormulaArg(significance)
  1805. }
  1806. }
  1807. val, res := math.Modf(number.Number / significance)
  1808. if res != 0 {
  1809. if number.Number < 0 {
  1810. val--
  1811. }
  1812. }
  1813. return newNumberFormulaArg(val * significance)
  1814. }
  1815. // gcd returns the greatest common divisor of two supplied integers.
  1816. func gcd(x, y float64) float64 {
  1817. x, y = math.Trunc(x), math.Trunc(y)
  1818. if x == 0 {
  1819. return y
  1820. }
  1821. if y == 0 {
  1822. return x
  1823. }
  1824. for x != y {
  1825. if x > y {
  1826. x = x - y
  1827. } else {
  1828. y = y - x
  1829. }
  1830. }
  1831. return x
  1832. }
  1833. // GCD function returns the greatest common divisor of two or more supplied
  1834. // integers. The syntax of the function is:
  1835. //
  1836. // GCD(number1,[number2],...)
  1837. //
  1838. func (fn *formulaFuncs) GCD(argsList *list.List) formulaArg {
  1839. if argsList.Len() == 0 {
  1840. return newErrorFormulaArg(formulaErrorVALUE, "GCD requires at least 1 argument")
  1841. }
  1842. var (
  1843. val float64
  1844. nums = []float64{}
  1845. err error
  1846. )
  1847. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  1848. token := arg.Value.(formulaArg)
  1849. switch token.Type {
  1850. case ArgString:
  1851. if token.String == "" {
  1852. continue
  1853. }
  1854. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  1855. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  1856. }
  1857. break
  1858. case ArgNumber:
  1859. val = token.Number
  1860. break
  1861. }
  1862. nums = append(nums, val)
  1863. }
  1864. if nums[0] < 0 {
  1865. return newErrorFormulaArg(formulaErrorVALUE, "GCD only accepts positive arguments")
  1866. }
  1867. if len(nums) == 1 {
  1868. return newNumberFormulaArg(nums[0])
  1869. }
  1870. cd := nums[0]
  1871. for i := 1; i < len(nums); i++ {
  1872. if nums[i] < 0 {
  1873. return newErrorFormulaArg(formulaErrorVALUE, "GCD only accepts positive arguments")
  1874. }
  1875. cd = gcd(cd, nums[i])
  1876. }
  1877. return newNumberFormulaArg(cd)
  1878. }
  1879. // INT function truncates a supplied number down to the closest integer. The
  1880. // syntax of the function is:
  1881. //
  1882. // INT(number)
  1883. //
  1884. func (fn *formulaFuncs) INT(argsList *list.List) formulaArg {
  1885. if argsList.Len() != 1 {
  1886. return newErrorFormulaArg(formulaErrorVALUE, "INT requires 1 numeric argument")
  1887. }
  1888. number := argsList.Front().Value.(formulaArg).ToNumber()
  1889. if number.Type == ArgError {
  1890. return number
  1891. }
  1892. val, frac := math.Modf(number.Number)
  1893. if frac < 0 {
  1894. val--
  1895. }
  1896. return newNumberFormulaArg(val)
  1897. }
  1898. // ISOCEILING function rounds a supplied number up (regardless of the number's
  1899. // sign), to the nearest multiple of a supplied significance. The syntax of
  1900. // the function is:
  1901. //
  1902. // ISO.CEILING(number,[significance])
  1903. //
  1904. func (fn *formulaFuncs) ISOCEILING(argsList *list.List) formulaArg {
  1905. if argsList.Len() == 0 {
  1906. return newErrorFormulaArg(formulaErrorVALUE, "ISO.CEILING requires at least 1 argument")
  1907. }
  1908. if argsList.Len() > 2 {
  1909. return newErrorFormulaArg(formulaErrorVALUE, "ISO.CEILING allows at most 2 arguments")
  1910. }
  1911. var significance float64
  1912. number := argsList.Front().Value.(formulaArg).ToNumber()
  1913. if number.Type == ArgError {
  1914. return number
  1915. }
  1916. if number.Number < 0 {
  1917. significance = -1
  1918. }
  1919. if argsList.Len() == 1 {
  1920. return newNumberFormulaArg(math.Ceil(number.Number))
  1921. }
  1922. if argsList.Len() > 1 {
  1923. s := argsList.Back().Value.(formulaArg).ToNumber()
  1924. if s.Type == ArgError {
  1925. return s
  1926. }
  1927. significance = s.Number
  1928. significance = math.Abs(significance)
  1929. if significance == 0 {
  1930. return newNumberFormulaArg(significance)
  1931. }
  1932. }
  1933. val, res := math.Modf(number.Number / significance)
  1934. if res != 0 {
  1935. if number.Number > 0 {
  1936. val++
  1937. }
  1938. }
  1939. return newNumberFormulaArg(val * significance)
  1940. }
  1941. // lcm returns the least common multiple of two supplied integers.
  1942. func lcm(a, b float64) float64 {
  1943. a = math.Trunc(a)
  1944. b = math.Trunc(b)
  1945. if a == 0 && b == 0 {
  1946. return 0
  1947. }
  1948. return a * b / gcd(a, b)
  1949. }
  1950. // LCM function returns the least common multiple of two or more supplied
  1951. // integers. The syntax of the function is:
  1952. //
  1953. // LCM(number1,[number2],...)
  1954. //
  1955. func (fn *formulaFuncs) LCM(argsList *list.List) formulaArg {
  1956. if argsList.Len() == 0 {
  1957. return newErrorFormulaArg(formulaErrorVALUE, "LCM requires at least 1 argument")
  1958. }
  1959. var (
  1960. val float64
  1961. nums = []float64{}
  1962. err error
  1963. )
  1964. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  1965. token := arg.Value.(formulaArg)
  1966. switch token.Type {
  1967. case ArgString:
  1968. if token.String == "" {
  1969. continue
  1970. }
  1971. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  1972. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  1973. }
  1974. break
  1975. case ArgNumber:
  1976. val = token.Number
  1977. break
  1978. }
  1979. nums = append(nums, val)
  1980. }
  1981. if nums[0] < 0 {
  1982. return newErrorFormulaArg(formulaErrorVALUE, "LCM only accepts positive arguments")
  1983. }
  1984. if len(nums) == 1 {
  1985. return newNumberFormulaArg(nums[0])
  1986. }
  1987. cm := nums[0]
  1988. for i := 1; i < len(nums); i++ {
  1989. if nums[i] < 0 {
  1990. return newErrorFormulaArg(formulaErrorVALUE, "LCM only accepts positive arguments")
  1991. }
  1992. cm = lcm(cm, nums[i])
  1993. }
  1994. return newNumberFormulaArg(cm)
  1995. }
  1996. // LN function calculates the natural logarithm of a given number. The syntax
  1997. // of the function is:
  1998. //
  1999. // LN(number)
  2000. //
  2001. func (fn *formulaFuncs) LN(argsList *list.List) formulaArg {
  2002. if argsList.Len() != 1 {
  2003. return newErrorFormulaArg(formulaErrorVALUE, "LN requires 1 numeric argument")
  2004. }
  2005. number := argsList.Front().Value.(formulaArg).ToNumber()
  2006. if number.Type == ArgError {
  2007. return number
  2008. }
  2009. return newNumberFormulaArg(math.Log(number.Number))
  2010. }
  2011. // LOG function calculates the logarithm of a given number, to a supplied
  2012. // base. The syntax of the function is:
  2013. //
  2014. // LOG(number,[base])
  2015. //
  2016. func (fn *formulaFuncs) LOG(argsList *list.List) formulaArg {
  2017. if argsList.Len() == 0 {
  2018. return newErrorFormulaArg(formulaErrorVALUE, "LOG requires at least 1 argument")
  2019. }
  2020. if argsList.Len() > 2 {
  2021. return newErrorFormulaArg(formulaErrorVALUE, "LOG allows at most 2 arguments")
  2022. }
  2023. base := 10.0
  2024. number := argsList.Front().Value.(formulaArg).ToNumber()
  2025. if number.Type == ArgError {
  2026. return number
  2027. }
  2028. if argsList.Len() > 1 {
  2029. b := argsList.Back().Value.(formulaArg).ToNumber()
  2030. if b.Type == ArgError {
  2031. return b
  2032. }
  2033. base = b.Number
  2034. }
  2035. if number.Number == 0 {
  2036. return newErrorFormulaArg(formulaErrorNUM, formulaErrorDIV)
  2037. }
  2038. if base == 0 {
  2039. return newErrorFormulaArg(formulaErrorNUM, formulaErrorDIV)
  2040. }
  2041. if base == 1 {
  2042. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  2043. }
  2044. return newNumberFormulaArg(math.Log(number.Number) / math.Log(base))
  2045. }
  2046. // LOG10 function calculates the base 10 logarithm of a given number. The
  2047. // syntax of the function is:
  2048. //
  2049. // LOG10(number)
  2050. //
  2051. func (fn *formulaFuncs) LOG10(argsList *list.List) formulaArg {
  2052. if argsList.Len() != 1 {
  2053. return newErrorFormulaArg(formulaErrorVALUE, "LOG10 requires 1 numeric argument")
  2054. }
  2055. number := argsList.Front().Value.(formulaArg).ToNumber()
  2056. if number.Type == ArgError {
  2057. return number
  2058. }
  2059. return newNumberFormulaArg(math.Log10(number.Number))
  2060. }
  2061. // minor function implement a minor of a matrix A is the determinant of some
  2062. // smaller square matrix.
  2063. func minor(sqMtx [][]float64, idx int) [][]float64 {
  2064. ret := [][]float64{}
  2065. for i := range sqMtx {
  2066. if i == 0 {
  2067. continue
  2068. }
  2069. row := []float64{}
  2070. for j := range sqMtx {
  2071. if j == idx {
  2072. continue
  2073. }
  2074. row = append(row, sqMtx[i][j])
  2075. }
  2076. ret = append(ret, row)
  2077. }
  2078. return ret
  2079. }
  2080. // det determinant of the 2x2 matrix.
  2081. func det(sqMtx [][]float64) float64 {
  2082. if len(sqMtx) == 2 {
  2083. m00 := sqMtx[0][0]
  2084. m01 := sqMtx[0][1]
  2085. m10 := sqMtx[1][0]
  2086. m11 := sqMtx[1][1]
  2087. return m00*m11 - m10*m01
  2088. }
  2089. var res, sgn float64 = 0, 1
  2090. for j := range sqMtx {
  2091. res += sgn * sqMtx[0][j] * det(minor(sqMtx, j))
  2092. sgn *= -1
  2093. }
  2094. return res
  2095. }
  2096. // MDETERM calculates the determinant of a square matrix. The
  2097. // syntax of the function is:
  2098. //
  2099. // MDETERM(array)
  2100. //
  2101. func (fn *formulaFuncs) MDETERM(argsList *list.List) (result formulaArg) {
  2102. var (
  2103. num float64
  2104. numMtx = [][]float64{}
  2105. err error
  2106. strMtx [][]formulaArg
  2107. )
  2108. if argsList.Len() < 1 {
  2109. return newErrorFormulaArg(formulaErrorVALUE, "MDETERM requires at least 1 argument")
  2110. }
  2111. strMtx = argsList.Front().Value.(formulaArg).Matrix
  2112. var rows = len(strMtx)
  2113. for _, row := range argsList.Front().Value.(formulaArg).Matrix {
  2114. if len(row) != rows {
  2115. return newErrorFormulaArg(formulaErrorVALUE, formulaErrorVALUE)
  2116. }
  2117. numRow := []float64{}
  2118. for _, ele := range row {
  2119. if num, err = strconv.ParseFloat(ele.String, 64); err != nil {
  2120. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2121. }
  2122. numRow = append(numRow, num)
  2123. }
  2124. numMtx = append(numMtx, numRow)
  2125. }
  2126. return newNumberFormulaArg(det(numMtx))
  2127. }
  2128. // MOD function returns the remainder of a division between two supplied
  2129. // numbers. The syntax of the function is:
  2130. //
  2131. // MOD(number,divisor)
  2132. //
  2133. func (fn *formulaFuncs) MOD(argsList *list.List) formulaArg {
  2134. if argsList.Len() != 2 {
  2135. return newErrorFormulaArg(formulaErrorVALUE, "MOD requires 2 numeric arguments")
  2136. }
  2137. number := argsList.Front().Value.(formulaArg).ToNumber()
  2138. if number.Type == ArgError {
  2139. return number
  2140. }
  2141. divisor := argsList.Back().Value.(formulaArg).ToNumber()
  2142. if divisor.Type == ArgError {
  2143. return divisor
  2144. }
  2145. if divisor.Number == 0 {
  2146. return newErrorFormulaArg(formulaErrorDIV, "MOD divide by zero")
  2147. }
  2148. trunc, rem := math.Modf(number.Number / divisor.Number)
  2149. if rem < 0 {
  2150. trunc--
  2151. }
  2152. return newNumberFormulaArg(number.Number - divisor.Number*trunc)
  2153. }
  2154. // MROUND function rounds a supplied number up or down to the nearest multiple
  2155. // of a given number. The syntax of the function is:
  2156. //
  2157. // MROUND(number,multiple)
  2158. //
  2159. func (fn *formulaFuncs) MROUND(argsList *list.List) formulaArg {
  2160. if argsList.Len() != 2 {
  2161. return newErrorFormulaArg(formulaErrorVALUE, "MROUND requires 2 numeric arguments")
  2162. }
  2163. n := argsList.Front().Value.(formulaArg).ToNumber()
  2164. if n.Type == ArgError {
  2165. return n
  2166. }
  2167. multiple := argsList.Back().Value.(formulaArg).ToNumber()
  2168. if multiple.Type == ArgError {
  2169. return multiple
  2170. }
  2171. if multiple.Number == 0 {
  2172. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  2173. }
  2174. if multiple.Number < 0 && n.Number > 0 ||
  2175. multiple.Number > 0 && n.Number < 0 {
  2176. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  2177. }
  2178. number, res := math.Modf(n.Number / multiple.Number)
  2179. if math.Trunc(res+0.5) > 0 {
  2180. number++
  2181. }
  2182. return newNumberFormulaArg(number * multiple.Number)
  2183. }
  2184. // MULTINOMIAL function calculates the ratio of the factorial of a sum of
  2185. // supplied values to the product of factorials of those values. The syntax of
  2186. // the function is:
  2187. //
  2188. // MULTINOMIAL(number1,[number2],...)
  2189. //
  2190. func (fn *formulaFuncs) MULTINOMIAL(argsList *list.List) formulaArg {
  2191. val, num, denom := 0.0, 0.0, 1.0
  2192. var err error
  2193. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  2194. token := arg.Value.(formulaArg)
  2195. switch token.Type {
  2196. case ArgString:
  2197. if token.String == "" {
  2198. continue
  2199. }
  2200. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  2201. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2202. }
  2203. break
  2204. case ArgNumber:
  2205. val = token.Number
  2206. break
  2207. }
  2208. num += val
  2209. denom *= fact(val)
  2210. }
  2211. return newNumberFormulaArg(fact(num) / denom)
  2212. }
  2213. // MUNIT function returns the unit matrix for a specified dimension. The
  2214. // syntax of the function is:
  2215. //
  2216. // MUNIT(dimension)
  2217. //
  2218. func (fn *formulaFuncs) MUNIT(argsList *list.List) (result formulaArg) {
  2219. if argsList.Len() != 1 {
  2220. return newErrorFormulaArg(formulaErrorVALUE, "MUNIT requires 1 numeric argument")
  2221. }
  2222. dimension := argsList.Back().Value.(formulaArg).ToNumber()
  2223. if dimension.Type == ArgError {
  2224. return dimension
  2225. }
  2226. matrix := make([][]formulaArg, 0, int(dimension.Number))
  2227. for i := 0; i < int(dimension.Number); i++ {
  2228. row := make([]formulaArg, int(dimension.Number))
  2229. for j := 0; j < int(dimension.Number); j++ {
  2230. if i == j {
  2231. row[j] = newNumberFormulaArg(1.0)
  2232. } else {
  2233. row[j] = newNumberFormulaArg(0.0)
  2234. }
  2235. }
  2236. matrix = append(matrix, row)
  2237. }
  2238. return newMatrixFormulaArg(matrix)
  2239. }
  2240. // ODD function ounds a supplied number away from zero (i.e. rounds a positive
  2241. // number up and a negative number down), to the next odd number. The syntax
  2242. // of the function is:
  2243. //
  2244. // ODD(number)
  2245. //
  2246. func (fn *formulaFuncs) ODD(argsList *list.List) formulaArg {
  2247. if argsList.Len() != 1 {
  2248. return newErrorFormulaArg(formulaErrorVALUE, "ODD requires 1 numeric argument")
  2249. }
  2250. number := argsList.Back().Value.(formulaArg).ToNumber()
  2251. if number.Type == ArgError {
  2252. return number
  2253. }
  2254. if number.Number == 0 {
  2255. return newNumberFormulaArg(1)
  2256. }
  2257. sign := math.Signbit(number.Number)
  2258. m, frac := math.Modf((number.Number - 1) / 2)
  2259. val := m*2 + 1
  2260. if frac != 0 {
  2261. if !sign {
  2262. val += 2
  2263. } else {
  2264. val -= 2
  2265. }
  2266. }
  2267. return newNumberFormulaArg(val)
  2268. }
  2269. // PI function returns the value of the mathematical constant π (pi), accurate
  2270. // to 15 digits (14 decimal places). The syntax of the function is:
  2271. //
  2272. // PI()
  2273. //
  2274. func (fn *formulaFuncs) PI(argsList *list.List) formulaArg {
  2275. if argsList.Len() != 0 {
  2276. return newErrorFormulaArg(formulaErrorVALUE, "PI accepts no arguments")
  2277. }
  2278. return newNumberFormulaArg(math.Pi)
  2279. }
  2280. // POWER function calculates a given number, raised to a supplied power.
  2281. // The syntax of the function is:
  2282. //
  2283. // POWER(number,power)
  2284. //
  2285. func (fn *formulaFuncs) POWER(argsList *list.List) formulaArg {
  2286. if argsList.Len() != 2 {
  2287. return newErrorFormulaArg(formulaErrorVALUE, "POWER requires 2 numeric arguments")
  2288. }
  2289. x := argsList.Front().Value.(formulaArg).ToNumber()
  2290. if x.Type == ArgError {
  2291. return x
  2292. }
  2293. y := argsList.Back().Value.(formulaArg).ToNumber()
  2294. if y.Type == ArgError {
  2295. return y
  2296. }
  2297. if x.Number == 0 && y.Number == 0 {
  2298. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  2299. }
  2300. if x.Number == 0 && y.Number < 0 {
  2301. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  2302. }
  2303. return newNumberFormulaArg(math.Pow(x.Number, y.Number))
  2304. }
  2305. // PRODUCT function returns the product (multiplication) of a supplied set of
  2306. // numerical values. The syntax of the function is:
  2307. //
  2308. // PRODUCT(number1,[number2],...)
  2309. //
  2310. func (fn *formulaFuncs) PRODUCT(argsList *list.List) formulaArg {
  2311. val, product := 0.0, 1.0
  2312. var err error
  2313. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  2314. token := arg.Value.(formulaArg)
  2315. switch token.Type {
  2316. case ArgUnknown:
  2317. continue
  2318. case ArgString:
  2319. if token.String == "" {
  2320. continue
  2321. }
  2322. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  2323. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2324. }
  2325. product = product * val
  2326. break
  2327. case ArgNumber:
  2328. product = product * token.Number
  2329. break
  2330. case ArgMatrix:
  2331. for _, row := range token.Matrix {
  2332. for _, value := range row {
  2333. if value.String == "" {
  2334. continue
  2335. }
  2336. if val, err = strconv.ParseFloat(value.String, 64); err != nil {
  2337. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2338. }
  2339. product = product * val
  2340. }
  2341. }
  2342. }
  2343. }
  2344. return newNumberFormulaArg(product)
  2345. }
  2346. // QUOTIENT function returns the integer portion of a division between two
  2347. // supplied numbers. The syntax of the function is:
  2348. //
  2349. // QUOTIENT(numerator,denominator)
  2350. //
  2351. func (fn *formulaFuncs) QUOTIENT(argsList *list.List) formulaArg {
  2352. if argsList.Len() != 2 {
  2353. return newErrorFormulaArg(formulaErrorVALUE, "QUOTIENT requires 2 numeric arguments")
  2354. }
  2355. x := argsList.Front().Value.(formulaArg).ToNumber()
  2356. if x.Type == ArgError {
  2357. return x
  2358. }
  2359. y := argsList.Back().Value.(formulaArg).ToNumber()
  2360. if y.Type == ArgError {
  2361. return y
  2362. }
  2363. if y.Number == 0 {
  2364. return newErrorFormulaArg(formulaErrorDIV, formulaErrorDIV)
  2365. }
  2366. return newNumberFormulaArg(math.Trunc(x.Number / y.Number))
  2367. }
  2368. // RADIANS function converts radians into degrees. The syntax of the function is:
  2369. //
  2370. // RADIANS(angle)
  2371. //
  2372. func (fn *formulaFuncs) RADIANS(argsList *list.List) formulaArg {
  2373. if argsList.Len() != 1 {
  2374. return newErrorFormulaArg(formulaErrorVALUE, "RADIANS requires 1 numeric argument")
  2375. }
  2376. angle := argsList.Front().Value.(formulaArg).ToNumber()
  2377. if angle.Type == ArgError {
  2378. return angle
  2379. }
  2380. return newNumberFormulaArg(math.Pi / 180.0 * angle.Number)
  2381. }
  2382. // RAND function generates a random real number between 0 and 1. The syntax of
  2383. // the function is:
  2384. //
  2385. // RAND()
  2386. //
  2387. func (fn *formulaFuncs) RAND(argsList *list.List) formulaArg {
  2388. if argsList.Len() != 0 {
  2389. return newErrorFormulaArg(formulaErrorVALUE, "RAND accepts no arguments")
  2390. }
  2391. return newNumberFormulaArg(rand.New(rand.NewSource(time.Now().UnixNano())).Float64())
  2392. }
  2393. // RANDBETWEEN function generates a random integer between two supplied
  2394. // integers. The syntax of the function is:
  2395. //
  2396. // RANDBETWEEN(bottom,top)
  2397. //
  2398. func (fn *formulaFuncs) RANDBETWEEN(argsList *list.List) formulaArg {
  2399. if argsList.Len() != 2 {
  2400. return newErrorFormulaArg(formulaErrorVALUE, "RANDBETWEEN requires 2 numeric arguments")
  2401. }
  2402. bottom := argsList.Front().Value.(formulaArg).ToNumber()
  2403. if bottom.Type == ArgError {
  2404. return bottom
  2405. }
  2406. top := argsList.Back().Value.(formulaArg).ToNumber()
  2407. if top.Type == ArgError {
  2408. return top
  2409. }
  2410. if top.Number < bottom.Number {
  2411. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  2412. }
  2413. return newNumberFormulaArg(float64(rand.New(rand.NewSource(time.Now().UnixNano())).Int63n(int64(top.Number-bottom.Number+1)) + int64(bottom.Number)))
  2414. }
  2415. // romanNumerals defined a numeral system that originated in ancient Rome and
  2416. // remained the usual way of writing numbers throughout Europe well into the
  2417. // Late Middle Ages.
  2418. type romanNumerals struct {
  2419. n float64
  2420. s string
  2421. }
  2422. var romanTable = [][]romanNumerals{{{1000, "M"}, {900, "CM"}, {500, "D"}, {400, "CD"}, {100, "C"}, {90, "XC"}, {50, "L"}, {40, "XL"}, {10, "X"}, {9, "IX"}, {5, "V"}, {4, "IV"}, {1, "I"}},
  2423. {{1000, "M"}, {950, "LM"}, {900, "CM"}, {500, "D"}, {450, "LD"}, {400, "CD"}, {100, "C"}, {95, "VC"}, {90, "XC"}, {50, "L"}, {45, "VL"}, {40, "XL"}, {10, "X"}, {9, "IX"}, {5, "V"}, {4, "IV"}, {1, "I"}},
  2424. {{1000, "M"}, {990, "XM"}, {950, "LM"}, {900, "CM"}, {500, "D"}, {490, "XD"}, {450, "LD"}, {400, "CD"}, {100, "C"}, {99, "IC"}, {90, "XC"}, {50, "L"}, {45, "VL"}, {40, "XL"}, {10, "X"}, {9, "IX"}, {5, "V"}, {4, "IV"}, {1, "I"}},
  2425. {{1000, "M"}, {995, "VM"}, {990, "XM"}, {950, "LM"}, {900, "CM"}, {500, "D"}, {495, "VD"}, {490, "XD"}, {450, "LD"}, {400, "CD"}, {100, "C"}, {99, "IC"}, {90, "XC"}, {50, "L"}, {45, "VL"}, {40, "XL"}, {10, "X"}, {9, "IX"}, {5, "V"}, {4, "IV"}, {1, "I"}},
  2426. {{1000, "M"}, {999, "IM"}, {995, "VM"}, {990, "XM"}, {950, "LM"}, {900, "CM"}, {500, "D"}, {499, "ID"}, {495, "VD"}, {490, "XD"}, {450, "LD"}, {400, "CD"}, {100, "C"}, {99, "IC"}, {90, "XC"}, {50, "L"}, {45, "VL"}, {40, "XL"}, {10, "X"}, {9, "IX"}, {5, "V"}, {4, "IV"}, {1, "I"}}}
  2427. // ROMAN function converts an arabic number to Roman. I.e. for a supplied
  2428. // integer, the function returns a text string depicting the roman numeral
  2429. // form of the number. The syntax of the function is:
  2430. //
  2431. // ROMAN(number,[form])
  2432. //
  2433. func (fn *formulaFuncs) ROMAN(argsList *list.List) formulaArg {
  2434. if argsList.Len() == 0 {
  2435. return newErrorFormulaArg(formulaErrorVALUE, "ROMAN requires at least 1 argument")
  2436. }
  2437. if argsList.Len() > 2 {
  2438. return newErrorFormulaArg(formulaErrorVALUE, "ROMAN allows at most 2 arguments")
  2439. }
  2440. var form int
  2441. number := argsList.Front().Value.(formulaArg).ToNumber()
  2442. if number.Type == ArgError {
  2443. return number
  2444. }
  2445. if argsList.Len() > 1 {
  2446. f := argsList.Back().Value.(formulaArg).ToNumber()
  2447. if f.Type == ArgError {
  2448. return f
  2449. }
  2450. form = int(f.Number)
  2451. if form < 0 {
  2452. form = 0
  2453. } else if form > 4 {
  2454. form = 4
  2455. }
  2456. }
  2457. decimalTable := romanTable[0]
  2458. switch form {
  2459. case 1:
  2460. decimalTable = romanTable[1]
  2461. case 2:
  2462. decimalTable = romanTable[2]
  2463. case 3:
  2464. decimalTable = romanTable[3]
  2465. case 4:
  2466. decimalTable = romanTable[4]
  2467. }
  2468. val := math.Trunc(number.Number)
  2469. buf := bytes.Buffer{}
  2470. for _, r := range decimalTable {
  2471. for val >= r.n {
  2472. buf.WriteString(r.s)
  2473. val -= r.n
  2474. }
  2475. }
  2476. return newStringFormulaArg(buf.String())
  2477. }
  2478. type roundMode byte
  2479. const (
  2480. closest roundMode = iota
  2481. down
  2482. up
  2483. )
  2484. // round rounds a supplied number up or down.
  2485. func (fn *formulaFuncs) round(number, digits float64, mode roundMode) float64 {
  2486. var significance float64
  2487. if digits > 0 {
  2488. significance = math.Pow(1/10.0, digits)
  2489. } else {
  2490. significance = math.Pow(10.0, -digits)
  2491. }
  2492. val, res := math.Modf(number / significance)
  2493. switch mode {
  2494. case closest:
  2495. const eps = 0.499999999
  2496. if res >= eps {
  2497. val++
  2498. } else if res <= -eps {
  2499. val--
  2500. }
  2501. case down:
  2502. case up:
  2503. if res > 0 {
  2504. val++
  2505. } else if res < 0 {
  2506. val--
  2507. }
  2508. }
  2509. return val * significance
  2510. }
  2511. // ROUND function rounds a supplied number up or down, to a specified number
  2512. // of decimal places. The syntax of the function is:
  2513. //
  2514. // ROUND(number,num_digits)
  2515. //
  2516. func (fn *formulaFuncs) ROUND(argsList *list.List) formulaArg {
  2517. if argsList.Len() != 2 {
  2518. return newErrorFormulaArg(formulaErrorVALUE, "ROUND requires 2 numeric arguments")
  2519. }
  2520. number := argsList.Front().Value.(formulaArg).ToNumber()
  2521. if number.Type == ArgError {
  2522. return number
  2523. }
  2524. digits := argsList.Back().Value.(formulaArg).ToNumber()
  2525. if digits.Type == ArgError {
  2526. return digits
  2527. }
  2528. return newNumberFormulaArg(fn.round(number.Number, digits.Number, closest))
  2529. }
  2530. // ROUNDDOWN function rounds a supplied number down towards zero, to a
  2531. // specified number of decimal places. The syntax of the function is:
  2532. //
  2533. // ROUNDDOWN(number,num_digits)
  2534. //
  2535. func (fn *formulaFuncs) ROUNDDOWN(argsList *list.List) formulaArg {
  2536. if argsList.Len() != 2 {
  2537. return newErrorFormulaArg(formulaErrorVALUE, "ROUNDDOWN requires 2 numeric arguments")
  2538. }
  2539. number := argsList.Front().Value.(formulaArg).ToNumber()
  2540. if number.Type == ArgError {
  2541. return number
  2542. }
  2543. digits := argsList.Back().Value.(formulaArg).ToNumber()
  2544. if digits.Type == ArgError {
  2545. return digits
  2546. }
  2547. return newNumberFormulaArg(fn.round(number.Number, digits.Number, down))
  2548. }
  2549. // ROUNDUP function rounds a supplied number up, away from zero, to a
  2550. // specified number of decimal places. The syntax of the function is:
  2551. //
  2552. // ROUNDUP(number,num_digits)
  2553. //
  2554. func (fn *formulaFuncs) ROUNDUP(argsList *list.List) formulaArg {
  2555. if argsList.Len() != 2 {
  2556. return newErrorFormulaArg(formulaErrorVALUE, "ROUNDUP requires 2 numeric arguments")
  2557. }
  2558. number := argsList.Front().Value.(formulaArg).ToNumber()
  2559. if number.Type == ArgError {
  2560. return number
  2561. }
  2562. digits := argsList.Back().Value.(formulaArg).ToNumber()
  2563. if digits.Type == ArgError {
  2564. return digits
  2565. }
  2566. return newNumberFormulaArg(fn.round(number.Number, digits.Number, up))
  2567. }
  2568. // SEC function calculates the secant of a given angle. The syntax of the
  2569. // function is:
  2570. //
  2571. // SEC(number)
  2572. //
  2573. func (fn *formulaFuncs) SEC(argsList *list.List) formulaArg {
  2574. if argsList.Len() != 1 {
  2575. return newErrorFormulaArg(formulaErrorVALUE, "SEC requires 1 numeric argument")
  2576. }
  2577. number := argsList.Front().Value.(formulaArg).ToNumber()
  2578. if number.Type == ArgError {
  2579. return number
  2580. }
  2581. return newNumberFormulaArg(math.Cos(number.Number))
  2582. }
  2583. // SECH function calculates the hyperbolic secant (sech) of a supplied angle.
  2584. // The syntax of the function is:
  2585. //
  2586. // SECH(number)
  2587. //
  2588. func (fn *formulaFuncs) SECH(argsList *list.List) formulaArg {
  2589. if argsList.Len() != 1 {
  2590. return newErrorFormulaArg(formulaErrorVALUE, "SECH requires 1 numeric argument")
  2591. }
  2592. number := argsList.Front().Value.(formulaArg).ToNumber()
  2593. if number.Type == ArgError {
  2594. return number
  2595. }
  2596. return newNumberFormulaArg(1 / math.Cosh(number.Number))
  2597. }
  2598. // SIGN function returns the arithmetic sign (+1, -1 or 0) of a supplied
  2599. // number. I.e. if the number is positive, the Sign function returns +1, if
  2600. // the number is negative, the function returns -1 and if the number is 0
  2601. // (zero), the function returns 0. The syntax of the function is:
  2602. //
  2603. // SIGN(number)
  2604. //
  2605. func (fn *formulaFuncs) SIGN(argsList *list.List) formulaArg {
  2606. if argsList.Len() != 1 {
  2607. return newErrorFormulaArg(formulaErrorVALUE, "SIGN requires 1 numeric argument")
  2608. }
  2609. val := argsList.Front().Value.(formulaArg).ToNumber()
  2610. if val.Type == ArgError {
  2611. return val
  2612. }
  2613. if val.Number < 0 {
  2614. return newNumberFormulaArg(-1)
  2615. }
  2616. if val.Number > 0 {
  2617. return newNumberFormulaArg(1)
  2618. }
  2619. return newNumberFormulaArg(0)
  2620. }
  2621. // SIN function calculates the sine of a given angle. The syntax of the
  2622. // function is:
  2623. //
  2624. // SIN(number)
  2625. //
  2626. func (fn *formulaFuncs) SIN(argsList *list.List) formulaArg {
  2627. if argsList.Len() != 1 {
  2628. return newErrorFormulaArg(formulaErrorVALUE, "SIN requires 1 numeric argument")
  2629. }
  2630. number := argsList.Front().Value.(formulaArg).ToNumber()
  2631. if number.Type == ArgError {
  2632. return number
  2633. }
  2634. return newNumberFormulaArg(math.Sin(number.Number))
  2635. }
  2636. // SINH function calculates the hyperbolic sine (sinh) of a supplied number.
  2637. // The syntax of the function is:
  2638. //
  2639. // SINH(number)
  2640. //
  2641. func (fn *formulaFuncs) SINH(argsList *list.List) formulaArg {
  2642. if argsList.Len() != 1 {
  2643. return newErrorFormulaArg(formulaErrorVALUE, "SINH requires 1 numeric argument")
  2644. }
  2645. number := argsList.Front().Value.(formulaArg).ToNumber()
  2646. if number.Type == ArgError {
  2647. return number
  2648. }
  2649. return newNumberFormulaArg(math.Sinh(number.Number))
  2650. }
  2651. // SQRT function calculates the positive square root of a supplied number. The
  2652. // syntax of the function is:
  2653. //
  2654. // SQRT(number)
  2655. //
  2656. func (fn *formulaFuncs) SQRT(argsList *list.List) formulaArg {
  2657. if argsList.Len() != 1 {
  2658. return newErrorFormulaArg(formulaErrorVALUE, "SQRT requires 1 numeric argument")
  2659. }
  2660. value := argsList.Front().Value.(formulaArg).ToNumber()
  2661. if value.Type == ArgError {
  2662. return value
  2663. }
  2664. if value.Number < 0 {
  2665. return newErrorFormulaArg(formulaErrorNUM, formulaErrorNUM)
  2666. }
  2667. return newNumberFormulaArg(math.Sqrt(value.Number))
  2668. }
  2669. // SQRTPI function returns the square root of a supplied number multiplied by
  2670. // the mathematical constant, π. The syntax of the function is:
  2671. //
  2672. // SQRTPI(number)
  2673. //
  2674. func (fn *formulaFuncs) SQRTPI(argsList *list.List) formulaArg {
  2675. if argsList.Len() != 1 {
  2676. return newErrorFormulaArg(formulaErrorVALUE, "SQRTPI requires 1 numeric argument")
  2677. }
  2678. number := argsList.Front().Value.(formulaArg).ToNumber()
  2679. if number.Type == ArgError {
  2680. return number
  2681. }
  2682. return newNumberFormulaArg(math.Sqrt(number.Number * math.Pi))
  2683. }
  2684. // SUM function adds together a supplied set of numbers and returns the sum of
  2685. // these values. The syntax of the function is:
  2686. //
  2687. // SUM(number1,[number2],...)
  2688. //
  2689. func (fn *formulaFuncs) SUM(argsList *list.List) formulaArg {
  2690. var (
  2691. val, sum float64
  2692. err error
  2693. )
  2694. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  2695. token := arg.Value.(formulaArg)
  2696. switch token.Type {
  2697. case ArgUnknown:
  2698. continue
  2699. case ArgString:
  2700. if token.String == "" {
  2701. continue
  2702. }
  2703. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  2704. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2705. }
  2706. sum += val
  2707. case ArgNumber:
  2708. sum += token.Number
  2709. case ArgMatrix:
  2710. for _, row := range token.Matrix {
  2711. for _, value := range row {
  2712. if value.String == "" {
  2713. continue
  2714. }
  2715. if val, err = strconv.ParseFloat(value.String, 64); err != nil {
  2716. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2717. }
  2718. sum += val
  2719. }
  2720. }
  2721. }
  2722. }
  2723. return newNumberFormulaArg(sum)
  2724. }
  2725. // SUMIF function finds the values in a supplied array, that satisfy a given
  2726. // criteria, and returns the sum of the corresponding values in a second
  2727. // supplied array. The syntax of the function is:
  2728. //
  2729. // SUMIF(range,criteria,[sum_range])
  2730. //
  2731. func (fn *formulaFuncs) SUMIF(argsList *list.List) formulaArg {
  2732. if argsList.Len() < 2 {
  2733. return newErrorFormulaArg(formulaErrorVALUE, "SUMIF requires at least 2 argument")
  2734. }
  2735. var criteria = formulaCriteriaParser(argsList.Front().Next().Value.(formulaArg).String)
  2736. var rangeMtx = argsList.Front().Value.(formulaArg).Matrix
  2737. var sumRange [][]formulaArg
  2738. if argsList.Len() == 3 {
  2739. sumRange = argsList.Back().Value.(formulaArg).Matrix
  2740. }
  2741. var sum, val float64
  2742. var err error
  2743. for rowIdx, row := range rangeMtx {
  2744. for colIdx, col := range row {
  2745. var ok bool
  2746. fromVal := col.String
  2747. if col.String == "" {
  2748. continue
  2749. }
  2750. if ok, err = formulaCriteriaEval(fromVal, criteria); err != nil {
  2751. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2752. }
  2753. if ok {
  2754. if argsList.Len() == 3 {
  2755. if len(sumRange) <= rowIdx || len(sumRange[rowIdx]) <= colIdx {
  2756. continue
  2757. }
  2758. fromVal = sumRange[rowIdx][colIdx].String
  2759. }
  2760. if val, err = strconv.ParseFloat(fromVal, 64); err != nil {
  2761. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2762. }
  2763. sum += val
  2764. }
  2765. }
  2766. }
  2767. return newNumberFormulaArg(sum)
  2768. }
  2769. // SUMSQ function returns the sum of squares of a supplied set of values. The
  2770. // syntax of the function is:
  2771. //
  2772. // SUMSQ(number1,[number2],...)
  2773. //
  2774. func (fn *formulaFuncs) SUMSQ(argsList *list.List) formulaArg {
  2775. var val, sq float64
  2776. var err error
  2777. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  2778. token := arg.Value.(formulaArg)
  2779. switch token.Type {
  2780. case ArgString:
  2781. if token.String == "" {
  2782. continue
  2783. }
  2784. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  2785. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2786. }
  2787. sq += val * val
  2788. break
  2789. case ArgNumber:
  2790. sq += token.Number
  2791. break
  2792. case ArgMatrix:
  2793. for _, row := range token.Matrix {
  2794. for _, value := range row {
  2795. if value.String == "" {
  2796. continue
  2797. }
  2798. if val, err = strconv.ParseFloat(value.String, 64); err != nil {
  2799. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2800. }
  2801. sq += val * val
  2802. }
  2803. }
  2804. }
  2805. }
  2806. return newNumberFormulaArg(sq)
  2807. }
  2808. // TAN function calculates the tangent of a given angle. The syntax of the
  2809. // function is:
  2810. //
  2811. // TAN(number)
  2812. //
  2813. func (fn *formulaFuncs) TAN(argsList *list.List) formulaArg {
  2814. if argsList.Len() != 1 {
  2815. return newErrorFormulaArg(formulaErrorVALUE, "TAN requires 1 numeric argument")
  2816. }
  2817. number := argsList.Front().Value.(formulaArg).ToNumber()
  2818. if number.Type == ArgError {
  2819. return number
  2820. }
  2821. return newNumberFormulaArg(math.Tan(number.Number))
  2822. }
  2823. // TANH function calculates the hyperbolic tangent (tanh) of a supplied
  2824. // number. The syntax of the function is:
  2825. //
  2826. // TANH(number)
  2827. //
  2828. func (fn *formulaFuncs) TANH(argsList *list.List) formulaArg {
  2829. if argsList.Len() != 1 {
  2830. return newErrorFormulaArg(formulaErrorVALUE, "TANH requires 1 numeric argument")
  2831. }
  2832. number := argsList.Front().Value.(formulaArg).ToNumber()
  2833. if number.Type == ArgError {
  2834. return number
  2835. }
  2836. return newNumberFormulaArg(math.Tanh(number.Number))
  2837. }
  2838. // TRUNC function truncates a supplied number to a specified number of decimal
  2839. // places. The syntax of the function is:
  2840. //
  2841. // TRUNC(number,[number_digits])
  2842. //
  2843. func (fn *formulaFuncs) TRUNC(argsList *list.List) formulaArg {
  2844. if argsList.Len() == 0 {
  2845. return newErrorFormulaArg(formulaErrorVALUE, "TRUNC requires at least 1 argument")
  2846. }
  2847. var digits, adjust, rtrim float64
  2848. var err error
  2849. number := argsList.Front().Value.(formulaArg).ToNumber()
  2850. if number.Type == ArgError {
  2851. return number
  2852. }
  2853. if argsList.Len() > 1 {
  2854. d := argsList.Back().Value.(formulaArg).ToNumber()
  2855. if d.Type == ArgError {
  2856. return d
  2857. }
  2858. digits = d.Number
  2859. digits = math.Floor(digits)
  2860. }
  2861. adjust = math.Pow(10, digits)
  2862. x := int((math.Abs(number.Number) - math.Abs(float64(int(number.Number)))) * adjust)
  2863. if x != 0 {
  2864. if rtrim, err = strconv.ParseFloat(strings.TrimRight(strconv.Itoa(x), "0"), 64); err != nil {
  2865. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2866. }
  2867. }
  2868. if (digits > 0) && (rtrim < adjust/10) {
  2869. return newNumberFormulaArg(number.Number)
  2870. }
  2871. return newNumberFormulaArg(float64(int(number.Number*adjust)) / adjust)
  2872. }
  2873. // Statistical functions
  2874. // COUNTA function returns the number of non-blanks within a supplied set of
  2875. // cells or values. The syntax of the function is:
  2876. //
  2877. // COUNTA(value1,[value2],...)
  2878. //
  2879. func (fn *formulaFuncs) COUNTA(argsList *list.List) formulaArg {
  2880. var count int
  2881. for token := argsList.Front(); token != nil; token = token.Next() {
  2882. arg := token.Value.(formulaArg)
  2883. switch arg.Type {
  2884. case ArgString:
  2885. if arg.String != "" {
  2886. count++
  2887. }
  2888. case ArgMatrix:
  2889. for _, row := range arg.Matrix {
  2890. for _, value := range row {
  2891. if value.String != "" {
  2892. count++
  2893. }
  2894. }
  2895. }
  2896. }
  2897. }
  2898. return newStringFormulaArg(fmt.Sprintf("%d", count))
  2899. }
  2900. // MEDIAN function returns the statistical median (the middle value) of a list
  2901. // of supplied numbers. The syntax of the function is:
  2902. //
  2903. // MEDIAN(number1,[number2],...)
  2904. //
  2905. func (fn *formulaFuncs) MEDIAN(argsList *list.List) formulaArg {
  2906. if argsList.Len() == 0 {
  2907. return newErrorFormulaArg(formulaErrorVALUE, "MEDIAN requires at least 1 argument")
  2908. }
  2909. var values = []float64{}
  2910. var median, digits float64
  2911. var err error
  2912. for token := argsList.Front(); token != nil; token = token.Next() {
  2913. arg := token.Value.(formulaArg)
  2914. switch arg.Type {
  2915. case ArgString:
  2916. if digits, err = strconv.ParseFloat(argsList.Back().Value.(formulaArg).String, 64); err != nil {
  2917. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2918. }
  2919. values = append(values, digits)
  2920. break
  2921. case ArgNumber:
  2922. values = append(values, arg.Number)
  2923. break
  2924. case ArgMatrix:
  2925. for _, row := range arg.Matrix {
  2926. for _, value := range row {
  2927. if value.String == "" {
  2928. continue
  2929. }
  2930. if digits, err = strconv.ParseFloat(value.String, 64); err != nil {
  2931. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  2932. }
  2933. values = append(values, digits)
  2934. }
  2935. }
  2936. }
  2937. }
  2938. sort.Float64s(values)
  2939. if len(values)%2 == 0 {
  2940. median = (values[len(values)/2-1] + values[len(values)/2]) / 2
  2941. } else {
  2942. median = values[len(values)/2]
  2943. }
  2944. return newNumberFormulaArg(median)
  2945. }
  2946. // Information functions
  2947. // ISBLANK function tests if a specified cell is blank (empty) and if so,
  2948. // returns TRUE; Otherwise the function returns FALSE. The syntax of the
  2949. // function is:
  2950. //
  2951. // ISBLANK(value)
  2952. //
  2953. func (fn *formulaFuncs) ISBLANK(argsList *list.List) formulaArg {
  2954. if argsList.Len() != 1 {
  2955. return newErrorFormulaArg(formulaErrorVALUE, "ISBLANK requires 1 argument")
  2956. }
  2957. token := argsList.Front().Value.(formulaArg)
  2958. result := "FALSE"
  2959. switch token.Type {
  2960. case ArgUnknown:
  2961. result = "TRUE"
  2962. case ArgString:
  2963. if token.String == "" {
  2964. result = "TRUE"
  2965. }
  2966. }
  2967. return newStringFormulaArg(result)
  2968. }
  2969. // ISERR function tests if an initial supplied expression (or value) returns
  2970. // any Excel Error, except the #N/A error. If so, the function returns the
  2971. // logical value TRUE; If the supplied value is not an error or is the #N/A
  2972. // error, the ISERR function returns FALSE. The syntax of the function is:
  2973. //
  2974. // ISERR(value)
  2975. //
  2976. func (fn *formulaFuncs) ISERR(argsList *list.List) formulaArg {
  2977. if argsList.Len() != 1 {
  2978. return newErrorFormulaArg(formulaErrorVALUE, "ISERR requires 1 argument")
  2979. }
  2980. token := argsList.Front().Value.(formulaArg)
  2981. result := "FALSE"
  2982. if token.Type == ArgString {
  2983. for _, errType := range []string{formulaErrorDIV, formulaErrorNAME, formulaErrorNUM, formulaErrorVALUE, formulaErrorREF, formulaErrorNULL, formulaErrorSPILL, formulaErrorCALC, formulaErrorGETTINGDATA} {
  2984. if errType == token.String {
  2985. result = "TRUE"
  2986. }
  2987. }
  2988. }
  2989. return newStringFormulaArg(result)
  2990. }
  2991. // ISERROR function tests if an initial supplied expression (or value) returns
  2992. // an Excel Error, and if so, returns the logical value TRUE; Otherwise the
  2993. // function returns FALSE. The syntax of the function is:
  2994. //
  2995. // ISERROR(value)
  2996. //
  2997. func (fn *formulaFuncs) ISERROR(argsList *list.List) formulaArg {
  2998. if argsList.Len() != 1 {
  2999. return newErrorFormulaArg(formulaErrorVALUE, "ISERROR requires 1 argument")
  3000. }
  3001. token := argsList.Front().Value.(formulaArg)
  3002. result := "FALSE"
  3003. if token.Type == ArgString {
  3004. for _, errType := range []string{formulaErrorDIV, formulaErrorNAME, formulaErrorNA, formulaErrorNUM, formulaErrorVALUE, formulaErrorREF, formulaErrorNULL, formulaErrorSPILL, formulaErrorCALC, formulaErrorGETTINGDATA} {
  3005. if errType == token.String {
  3006. result = "TRUE"
  3007. }
  3008. }
  3009. }
  3010. return newStringFormulaArg(result)
  3011. }
  3012. // ISEVEN function tests if a supplied number (or numeric expression)
  3013. // evaluates to an even number, and if so, returns TRUE; Otherwise, the
  3014. // function returns FALSE. The syntax of the function is:
  3015. //
  3016. // ISEVEN(value)
  3017. //
  3018. func (fn *formulaFuncs) ISEVEN(argsList *list.List) formulaArg {
  3019. if argsList.Len() != 1 {
  3020. return newErrorFormulaArg(formulaErrorVALUE, "ISEVEN requires 1 argument")
  3021. }
  3022. var (
  3023. token = argsList.Front().Value.(formulaArg)
  3024. result = "FALSE"
  3025. numeric int
  3026. err error
  3027. )
  3028. if token.Type == ArgString {
  3029. if numeric, err = strconv.Atoi(token.String); err != nil {
  3030. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  3031. }
  3032. if numeric == numeric/2*2 {
  3033. return newStringFormulaArg("TRUE")
  3034. }
  3035. }
  3036. return newStringFormulaArg(result)
  3037. }
  3038. // ISNA function tests if an initial supplied expression (or value) returns
  3039. // the Excel #N/A Error, and if so, returns TRUE; Otherwise the function
  3040. // returns FALSE. The syntax of the function is:
  3041. //
  3042. // ISNA(value)
  3043. //
  3044. func (fn *formulaFuncs) ISNA(argsList *list.List) formulaArg {
  3045. if argsList.Len() != 1 {
  3046. return newErrorFormulaArg(formulaErrorVALUE, "ISNA requires 1 argument")
  3047. }
  3048. token := argsList.Front().Value.(formulaArg)
  3049. result := "FALSE"
  3050. if token.Type == ArgString && token.String == formulaErrorNA {
  3051. result = "TRUE"
  3052. }
  3053. return newStringFormulaArg(result)
  3054. }
  3055. // ISNONTEXT function function tests if a supplied value is text. If not, the
  3056. // function returns TRUE; If the supplied value is text, the function returns
  3057. // FALSE. The syntax of the function is:
  3058. //
  3059. // ISNONTEXT(value)
  3060. //
  3061. func (fn *formulaFuncs) ISNONTEXT(argsList *list.List) formulaArg {
  3062. if argsList.Len() != 1 {
  3063. return newErrorFormulaArg(formulaErrorVALUE, "ISNONTEXT requires 1 argument")
  3064. }
  3065. token := argsList.Front().Value.(formulaArg)
  3066. result := "TRUE"
  3067. if token.Type == ArgString && token.String != "" {
  3068. result = "FALSE"
  3069. }
  3070. return newStringFormulaArg(result)
  3071. }
  3072. // ISNUMBER function function tests if a supplied value is a number. If so,
  3073. // the function returns TRUE; Otherwise it returns FALSE. The syntax of the
  3074. // function is:
  3075. //
  3076. // ISNUMBER(value)
  3077. //
  3078. func (fn *formulaFuncs) ISNUMBER(argsList *list.List) formulaArg {
  3079. if argsList.Len() != 1 {
  3080. return newErrorFormulaArg(formulaErrorVALUE, "ISNUMBER requires 1 argument")
  3081. }
  3082. token, result := argsList.Front().Value.(formulaArg), false
  3083. if token.Type == ArgString && token.String != "" {
  3084. if _, err := strconv.Atoi(token.String); err == nil {
  3085. result = true
  3086. }
  3087. }
  3088. return newBoolFormulaArg(result)
  3089. }
  3090. // ISODD function tests if a supplied number (or numeric expression) evaluates
  3091. // to an odd number, and if so, returns TRUE; Otherwise, the function returns
  3092. // FALSE. The syntax of the function is:
  3093. //
  3094. // ISODD(value)
  3095. //
  3096. func (fn *formulaFuncs) ISODD(argsList *list.List) formulaArg {
  3097. if argsList.Len() != 1 {
  3098. return newErrorFormulaArg(formulaErrorVALUE, "ISODD requires 1 argument")
  3099. }
  3100. var (
  3101. token = argsList.Front().Value.(formulaArg)
  3102. result = "FALSE"
  3103. numeric int
  3104. err error
  3105. )
  3106. if token.Type == ArgString {
  3107. if numeric, err = strconv.Atoi(token.String); err != nil {
  3108. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  3109. }
  3110. if numeric != numeric/2*2 {
  3111. return newStringFormulaArg("TRUE")
  3112. }
  3113. }
  3114. return newStringFormulaArg(result)
  3115. }
  3116. // NA function returns the Excel #N/A error. This error message has the
  3117. // meaning 'value not available' and is produced when an Excel Formula is
  3118. // unable to find a value that it needs. The syntax of the function is:
  3119. //
  3120. // NA()
  3121. //
  3122. func (fn *formulaFuncs) NA(argsList *list.List) formulaArg {
  3123. if argsList.Len() != 0 {
  3124. return newErrorFormulaArg(formulaErrorVALUE, "NA accepts no arguments")
  3125. }
  3126. return newStringFormulaArg(formulaErrorNA)
  3127. }
  3128. // Logical Functions
  3129. // AND function tests a number of supplied conditions and returns TRUE or
  3130. // FALSE. The syntax of the function is:
  3131. //
  3132. // AND(logical_test1,[logical_test2],...)
  3133. //
  3134. func (fn *formulaFuncs) AND(argsList *list.List) formulaArg {
  3135. if argsList.Len() == 0 {
  3136. return newErrorFormulaArg(formulaErrorVALUE, "AND requires at least 1 argument")
  3137. }
  3138. if argsList.Len() > 30 {
  3139. return newErrorFormulaArg(formulaErrorVALUE, "AND accepts at most 30 arguments")
  3140. }
  3141. var (
  3142. and = true
  3143. val float64
  3144. err error
  3145. )
  3146. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  3147. token := arg.Value.(formulaArg)
  3148. switch token.Type {
  3149. case ArgUnknown:
  3150. continue
  3151. case ArgString:
  3152. if token.String == "TRUE" {
  3153. continue
  3154. }
  3155. if token.String == "FALSE" {
  3156. return newStringFormulaArg(token.String)
  3157. }
  3158. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  3159. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  3160. }
  3161. and = and && (val != 0)
  3162. case ArgMatrix:
  3163. // TODO
  3164. return newErrorFormulaArg(formulaErrorVALUE, formulaErrorVALUE)
  3165. }
  3166. }
  3167. return newBoolFormulaArg(and)
  3168. }
  3169. // OR function tests a number of supplied conditions and returns either TRUE
  3170. // or FALSE. The syntax of the function is:
  3171. //
  3172. // OR(logical_test1,[logical_test2],...)
  3173. //
  3174. func (fn *formulaFuncs) OR(argsList *list.List) formulaArg {
  3175. if argsList.Len() == 0 {
  3176. return newErrorFormulaArg(formulaErrorVALUE, "OR requires at least 1 argument")
  3177. }
  3178. if argsList.Len() > 30 {
  3179. return newErrorFormulaArg(formulaErrorVALUE, "OR accepts at most 30 arguments")
  3180. }
  3181. var (
  3182. or bool
  3183. val float64
  3184. err error
  3185. )
  3186. for arg := argsList.Front(); arg != nil; arg = arg.Next() {
  3187. token := arg.Value.(formulaArg)
  3188. switch token.Type {
  3189. case ArgUnknown:
  3190. continue
  3191. case ArgString:
  3192. if token.String == "FALSE" {
  3193. continue
  3194. }
  3195. if token.String == "TRUE" {
  3196. or = true
  3197. continue
  3198. }
  3199. if val, err = strconv.ParseFloat(token.String, 64); err != nil {
  3200. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  3201. }
  3202. or = val != 0
  3203. case ArgMatrix:
  3204. // TODO
  3205. return newErrorFormulaArg(formulaErrorVALUE, formulaErrorVALUE)
  3206. }
  3207. }
  3208. return newStringFormulaArg(strings.ToUpper(strconv.FormatBool(or)))
  3209. }
  3210. // Date and Time Functions
  3211. // DATE returns a date, from a user-supplied year, month and day. The syntax
  3212. // of the function is:
  3213. //
  3214. // DATE(year,month,day)
  3215. //
  3216. func (fn *formulaFuncs) DATE(argsList *list.List) formulaArg {
  3217. if argsList.Len() != 3 {
  3218. return newErrorFormulaArg(formulaErrorVALUE, "DATE requires 3 number arguments")
  3219. }
  3220. var year, month, day int
  3221. var err error
  3222. if year, err = strconv.Atoi(argsList.Front().Value.(formulaArg).String); err != nil {
  3223. return newErrorFormulaArg(formulaErrorVALUE, "DATE requires 3 number arguments")
  3224. }
  3225. if month, err = strconv.Atoi(argsList.Front().Next().Value.(formulaArg).String); err != nil {
  3226. return newErrorFormulaArg(formulaErrorVALUE, "DATE requires 3 number arguments")
  3227. }
  3228. if day, err = strconv.Atoi(argsList.Back().Value.(formulaArg).String); err != nil {
  3229. return newErrorFormulaArg(formulaErrorVALUE, "DATE requires 3 number arguments")
  3230. }
  3231. d := makeDate(year, time.Month(month), day)
  3232. return newStringFormulaArg(timeFromExcelTime(daysBetween(excelMinTime1900.Unix(), d)+1, false).String())
  3233. }
  3234. // makeDate return date as a Unix time, the number of seconds elapsed since
  3235. // January 1, 1970 UTC.
  3236. func makeDate(y int, m time.Month, d int) int64 {
  3237. if y == 1900 && int(m) <= 2 {
  3238. d--
  3239. }
  3240. date := time.Date(y, m, d, 0, 0, 0, 0, time.UTC)
  3241. return date.Unix()
  3242. }
  3243. // daysBetween return time interval of the given start timestamp and end
  3244. // timestamp.
  3245. func daysBetween(startDate, endDate int64) float64 {
  3246. return float64(int(0.5 + float64((endDate-startDate)/86400)))
  3247. }
  3248. // Text Functions
  3249. // CLEAN removes all non-printable characters from a supplied text string. The
  3250. // syntax of the function is:
  3251. //
  3252. // CLEAN(text)
  3253. //
  3254. func (fn *formulaFuncs) CLEAN(argsList *list.List) formulaArg {
  3255. if argsList.Len() != 1 {
  3256. return newErrorFormulaArg(formulaErrorVALUE, "CLEAN requires 1 argument")
  3257. }
  3258. b := bytes.Buffer{}
  3259. for _, c := range argsList.Front().Value.(formulaArg).String {
  3260. if c > 31 {
  3261. b.WriteRune(c)
  3262. }
  3263. }
  3264. return newStringFormulaArg(b.String())
  3265. }
  3266. // LEN returns the length of a supplied text string. The syntax of the
  3267. // function is:
  3268. //
  3269. // LEN(text)
  3270. //
  3271. func (fn *formulaFuncs) LEN(argsList *list.List) formulaArg {
  3272. if argsList.Len() != 1 {
  3273. return newErrorFormulaArg(formulaErrorVALUE, "LEN requires 1 string argument")
  3274. }
  3275. return newStringFormulaArg(strconv.Itoa(len(argsList.Front().Value.(formulaArg).String)))
  3276. }
  3277. // TRIM removes extra spaces (i.e. all spaces except for single spaces between
  3278. // words or characters) from a supplied text string. The syntax of the
  3279. // function is:
  3280. //
  3281. // TRIM(text)
  3282. //
  3283. func (fn *formulaFuncs) TRIM(argsList *list.List) formulaArg {
  3284. if argsList.Len() != 1 {
  3285. return newErrorFormulaArg(formulaErrorVALUE, "TRIM requires 1 argument")
  3286. }
  3287. return newStringFormulaArg(strings.TrimSpace(argsList.Front().Value.(formulaArg).String))
  3288. }
  3289. // LOWER converts all characters in a supplied text string to lower case. The
  3290. // syntax of the function is:
  3291. //
  3292. // LOWER(text)
  3293. //
  3294. func (fn *formulaFuncs) LOWER(argsList *list.List) formulaArg {
  3295. if argsList.Len() != 1 {
  3296. return newErrorFormulaArg(formulaErrorVALUE, "LOWER requires 1 argument")
  3297. }
  3298. return newStringFormulaArg(strings.ToLower(argsList.Front().Value.(formulaArg).String))
  3299. }
  3300. // PROPER converts all characters in a supplied text string to proper case
  3301. // (i.e. all letters that do not immediately follow another letter are set to
  3302. // upper case and all other characters are lower case). The syntax of the
  3303. // function is:
  3304. //
  3305. // PROPER(text)
  3306. //
  3307. func (fn *formulaFuncs) PROPER(argsList *list.List) formulaArg {
  3308. if argsList.Len() != 1 {
  3309. return newErrorFormulaArg(formulaErrorVALUE, "PROPER requires 1 argument")
  3310. }
  3311. buf := bytes.Buffer{}
  3312. isLetter := false
  3313. for _, char := range argsList.Front().Value.(formulaArg).String {
  3314. if !isLetter && unicode.IsLetter(char) {
  3315. buf.WriteRune(unicode.ToUpper(char))
  3316. } else {
  3317. buf.WriteRune(unicode.ToLower(char))
  3318. }
  3319. isLetter = unicode.IsLetter(char)
  3320. }
  3321. return newStringFormulaArg(buf.String())
  3322. }
  3323. // UPPER converts all characters in a supplied text string to upper case. The
  3324. // syntax of the function is:
  3325. //
  3326. // UPPER(text)
  3327. //
  3328. func (fn *formulaFuncs) UPPER(argsList *list.List) formulaArg {
  3329. if argsList.Len() != 1 {
  3330. return newErrorFormulaArg(formulaErrorVALUE, "UPPER requires 1 argument")
  3331. }
  3332. return newStringFormulaArg(strings.ToUpper(argsList.Front().Value.(formulaArg).String))
  3333. }
  3334. // Conditional Functions
  3335. // IF function tests a supplied condition and returns one result if the
  3336. // condition evaluates to TRUE, and another result if the condition evaluates
  3337. // to FALSE. The syntax of the function is:
  3338. //
  3339. // IF(logical_test,value_if_true,value_if_false)
  3340. //
  3341. func (fn *formulaFuncs) IF(argsList *list.List) formulaArg {
  3342. if argsList.Len() == 0 {
  3343. return newErrorFormulaArg(formulaErrorVALUE, "IF requires at least 1 argument")
  3344. }
  3345. if argsList.Len() > 3 {
  3346. return newErrorFormulaArg(formulaErrorVALUE, "IF accepts at most 3 arguments")
  3347. }
  3348. token := argsList.Front().Value.(formulaArg)
  3349. var (
  3350. cond bool
  3351. err error
  3352. result string
  3353. )
  3354. switch token.Type {
  3355. case ArgString:
  3356. if cond, err = strconv.ParseBool(token.String); err != nil {
  3357. return newErrorFormulaArg(formulaErrorVALUE, err.Error())
  3358. }
  3359. if argsList.Len() == 1 {
  3360. return newBoolFormulaArg(cond)
  3361. }
  3362. if cond {
  3363. return newStringFormulaArg(argsList.Front().Next().Value.(formulaArg).String)
  3364. }
  3365. if argsList.Len() == 3 {
  3366. result = argsList.Back().Value.(formulaArg).String
  3367. }
  3368. }
  3369. return newStringFormulaArg(result)
  3370. }
  3371. // Excel Lookup and Reference Functions
  3372. // CHOOSE function returns a value from an array, that corresponds to a
  3373. // supplied index number (position). The syntax of the function is:
  3374. //
  3375. // CHOOSE(index_num,value1,[value2],...)
  3376. //
  3377. func (fn *formulaFuncs) CHOOSE(argsList *list.List) formulaArg {
  3378. if argsList.Len() < 2 {
  3379. return newErrorFormulaArg(formulaErrorVALUE, "CHOOSE requires 2 arguments")
  3380. }
  3381. idx, err := strconv.Atoi(argsList.Front().Value.(formulaArg).String)
  3382. if err != nil {
  3383. return newErrorFormulaArg(formulaErrorVALUE, "CHOOSE requires first argument of type number")
  3384. }
  3385. if argsList.Len() <= idx {
  3386. return newErrorFormulaArg(formulaErrorVALUE, "index_num should be <= to the number of values")
  3387. }
  3388. arg := argsList.Front()
  3389. for i := 0; i < idx; i++ {
  3390. arg = arg.Next()
  3391. }
  3392. var result formulaArg
  3393. switch arg.Value.(formulaArg).Type {
  3394. case ArgString:
  3395. result = newStringFormulaArg(arg.Value.(formulaArg).String)
  3396. case ArgMatrix:
  3397. result = newMatrixFormulaArg(arg.Value.(formulaArg).Matrix)
  3398. }
  3399. return result
  3400. }
  3401. // deepMatchRune finds whether the text deep matches/satisfies the pattern
  3402. // string.
  3403. func deepMatchRune(str, pattern []rune, simple bool) bool {
  3404. for len(pattern) > 0 {
  3405. switch pattern[0] {
  3406. default:
  3407. if len(str) == 0 || str[0] != pattern[0] {
  3408. return false
  3409. }
  3410. case '?':
  3411. if len(str) == 0 && !simple {
  3412. return false
  3413. }
  3414. case '*':
  3415. return deepMatchRune(str, pattern[1:], simple) ||
  3416. (len(str) > 0 && deepMatchRune(str[1:], pattern, simple))
  3417. }
  3418. str = str[1:]
  3419. pattern = pattern[1:]
  3420. }
  3421. return len(str) == 0 && len(pattern) == 0
  3422. }
  3423. // matchPattern finds whether the text matches or satisfies the pattern
  3424. // string. The pattern supports '*' and '?' wildcards in the pattern string.
  3425. func matchPattern(pattern, name string) (matched bool) {
  3426. if pattern == "" {
  3427. return name == pattern
  3428. }
  3429. if pattern == "*" {
  3430. return true
  3431. }
  3432. rname := make([]rune, 0, len(name))
  3433. rpattern := make([]rune, 0, len(pattern))
  3434. for _, r := range name {
  3435. rname = append(rname, r)
  3436. }
  3437. for _, r := range pattern {
  3438. rpattern = append(rpattern, r)
  3439. }
  3440. simple := false // Does extended wildcard '*' and '?' match.
  3441. return deepMatchRune(rname, rpattern, simple)
  3442. }
  3443. // compareFormulaArg compares the left-hand sides and the right-hand sides
  3444. // formula arguments by given conditions such as case sensitive, if exact
  3445. // match, and make compare result as formula criteria condition type.
  3446. func compareFormulaArg(lhs, rhs formulaArg, caseSensitive, exactMatch bool) byte {
  3447. if lhs.Type != rhs.Type {
  3448. return criteriaErr
  3449. }
  3450. switch lhs.Type {
  3451. case ArgNumber:
  3452. if lhs.Number == rhs.Number {
  3453. return criteriaEq
  3454. }
  3455. if lhs.Number < rhs.Number {
  3456. return criteriaL
  3457. }
  3458. return criteriaG
  3459. case ArgString:
  3460. ls := lhs.String
  3461. rs := rhs.String
  3462. if !caseSensitive {
  3463. ls = strings.ToLower(ls)
  3464. rs = strings.ToLower(rs)
  3465. }
  3466. if exactMatch {
  3467. match := matchPattern(rs, ls)
  3468. if match {
  3469. return criteriaEq
  3470. }
  3471. return criteriaG
  3472. }
  3473. return byte(strings.Compare(ls, rs))
  3474. case ArgEmpty:
  3475. return criteriaEq
  3476. case ArgList:
  3477. return compareFormulaArgList(lhs, rhs, caseSensitive, exactMatch)
  3478. case ArgMatrix:
  3479. return compareFormulaArgMatrix(lhs, rhs, caseSensitive, exactMatch)
  3480. }
  3481. return criteriaErr
  3482. }
  3483. // compareFormulaArgList compares the left-hand sides and the right-hand sides
  3484. // list type formula arguments.
  3485. func compareFormulaArgList(lhs, rhs formulaArg, caseSensitive, exactMatch bool) byte {
  3486. if len(lhs.List) < len(rhs.List) {
  3487. return criteriaL
  3488. }
  3489. if len(lhs.List) > len(rhs.List) {
  3490. return criteriaG
  3491. }
  3492. for arg := range lhs.List {
  3493. criteria := compareFormulaArg(lhs.List[arg], rhs.List[arg], caseSensitive, exactMatch)
  3494. if criteria != criteriaEq {
  3495. return criteria
  3496. }
  3497. }
  3498. return criteriaEq
  3499. }
  3500. // compareFormulaArgMatrix compares the left-hand sides and the right-hand sides
  3501. // matrix type formula arguments.
  3502. func compareFormulaArgMatrix(lhs, rhs formulaArg, caseSensitive, exactMatch bool) byte {
  3503. if len(lhs.Matrix) < len(rhs.Matrix) {
  3504. return criteriaL
  3505. }
  3506. if len(lhs.Matrix) > len(rhs.Matrix) {
  3507. return criteriaG
  3508. }
  3509. for i := range lhs.Matrix {
  3510. left := lhs.Matrix[i]
  3511. right := lhs.Matrix[i]
  3512. if len(left) < len(right) {
  3513. return criteriaL
  3514. }
  3515. if len(left) > len(right) {
  3516. return criteriaG
  3517. }
  3518. for arg := range left {
  3519. criteria := compareFormulaArg(left[arg], right[arg], caseSensitive, exactMatch)
  3520. if criteria != criteriaEq {
  3521. return criteria
  3522. }
  3523. }
  3524. }
  3525. return criteriaEq
  3526. }
  3527. // HLOOKUP function 'looks up' a given value in the top row of a data array
  3528. // (or table), and returns the corresponding value from another row of the
  3529. // array. The syntax of the function is:
  3530. //
  3531. // HLOOKUP(lookup_value,table_array,row_index_num,[range_lookup])
  3532. //
  3533. func (fn *formulaFuncs) HLOOKUP(argsList *list.List) formulaArg {
  3534. if argsList.Len() < 3 {
  3535. return newErrorFormulaArg(formulaErrorVALUE, "HLOOKUP requires at least 3 arguments")
  3536. }
  3537. if argsList.Len() > 4 {
  3538. return newErrorFormulaArg(formulaErrorVALUE, "HLOOKUP requires at most 4 arguments")
  3539. }
  3540. lookupValue := argsList.Front().Value.(formulaArg)
  3541. tableArray := argsList.Front().Next().Value.(formulaArg)
  3542. if tableArray.Type != ArgMatrix {
  3543. return newErrorFormulaArg(formulaErrorVALUE, "HLOOKUP requires second argument of table array")
  3544. }
  3545. rowArg := argsList.Front().Next().Next().Value.(formulaArg).ToNumber()
  3546. if rowArg.Type != ArgNumber {
  3547. return newErrorFormulaArg(formulaErrorVALUE, "HLOOKUP requires numeric row argument")
  3548. }
  3549. rowIdx, matchIdx, wasExact, exactMatch := int(rowArg.Number)-1, -1, false, false
  3550. if argsList.Len() == 4 {
  3551. rangeLookup := argsList.Back().Value.(formulaArg).ToBool()
  3552. if rangeLookup.Type == ArgError {
  3553. return newErrorFormulaArg(formulaErrorVALUE, rangeLookup.Error)
  3554. }
  3555. if rangeLookup.Number == 0 {
  3556. exactMatch = true
  3557. }
  3558. }
  3559. row := tableArray.Matrix[0]
  3560. start:
  3561. for idx, mtx := range row {
  3562. switch compareFormulaArg(mtx, lookupValue, false, exactMatch) {
  3563. case criteriaL:
  3564. matchIdx = idx
  3565. case criteriaEq:
  3566. matchIdx = idx
  3567. wasExact = true
  3568. break start
  3569. }
  3570. }
  3571. if matchIdx == -1 {
  3572. return newErrorFormulaArg(formulaErrorNA, "HLOOKUP no result found")
  3573. }
  3574. if rowIdx < 0 || rowIdx >= len(tableArray.Matrix) {
  3575. return newErrorFormulaArg(formulaErrorNA, "HLOOKUP has invalid row index")
  3576. }
  3577. row = tableArray.Matrix[rowIdx]
  3578. if wasExact || !exactMatch {
  3579. return row[matchIdx]
  3580. }
  3581. return newErrorFormulaArg(formulaErrorNA, "HLOOKUP no result found")
  3582. }
  3583. // VLOOKUP function 'looks up' a given value in the left-hand column of a
  3584. // data array (or table), and returns the corresponding value from another
  3585. // column of the array. The syntax of the function is:
  3586. //
  3587. // VLOOKUP(lookup_value,table_array,col_index_num,[range_lookup])
  3588. //
  3589. func (fn *formulaFuncs) VLOOKUP(argsList *list.List) formulaArg {
  3590. if argsList.Len() < 3 {
  3591. return newErrorFormulaArg(formulaErrorVALUE, "VLOOKUP requires at least 3 arguments")
  3592. }
  3593. if argsList.Len() > 4 {
  3594. return newErrorFormulaArg(formulaErrorVALUE, "VLOOKUP requires at most 4 arguments")
  3595. }
  3596. lookupValue := argsList.Front().Value.(formulaArg)
  3597. tableArray := argsList.Front().Next().Value.(formulaArg)
  3598. if tableArray.Type != ArgMatrix {
  3599. return newErrorFormulaArg(formulaErrorVALUE, "VLOOKUP requires second argument of table array")
  3600. }
  3601. colIdx := argsList.Front().Next().Next().Value.(formulaArg).ToNumber()
  3602. if colIdx.Type != ArgNumber {
  3603. return newErrorFormulaArg(formulaErrorVALUE, "VLOOKUP requires numeric col argument")
  3604. }
  3605. col, matchIdx, wasExact, exactMatch := int(colIdx.Number)-1, -1, false, false
  3606. if argsList.Len() == 4 {
  3607. rangeLookup := argsList.Back().Value.(formulaArg).ToBool()
  3608. if rangeLookup.Type == ArgError {
  3609. return newErrorFormulaArg(formulaErrorVALUE, rangeLookup.Error)
  3610. }
  3611. if rangeLookup.Number == 0 {
  3612. exactMatch = true
  3613. }
  3614. }
  3615. start:
  3616. for idx, mtx := range tableArray.Matrix {
  3617. if len(mtx) == 0 {
  3618. continue
  3619. }
  3620. lhs := mtx[0]
  3621. switch lookupValue.Type {
  3622. case ArgNumber:
  3623. if !lookupValue.Boolean {
  3624. lhs = mtx[0].ToNumber()
  3625. if lhs.Type == ArgError {
  3626. lhs = mtx[0]
  3627. }
  3628. }
  3629. case ArgMatrix:
  3630. lhs = tableArray
  3631. }
  3632. switch compareFormulaArg(lhs, lookupValue, false, exactMatch) {
  3633. case criteriaL:
  3634. matchIdx = idx
  3635. case criteriaEq:
  3636. matchIdx = idx
  3637. wasExact = true
  3638. break start
  3639. }
  3640. }
  3641. if matchIdx == -1 {
  3642. return newErrorFormulaArg(formulaErrorNA, "VLOOKUP no result found")
  3643. }
  3644. mtx := tableArray.Matrix[matchIdx]
  3645. if col < 0 || col >= len(mtx) {
  3646. return newErrorFormulaArg(formulaErrorNA, "VLOOKUP has invalid column index")
  3647. }
  3648. if wasExact || !exactMatch {
  3649. return mtx[col]
  3650. }
  3651. return newErrorFormulaArg(formulaErrorNA, "VLOOKUP no result found")
  3652. }