The markdown parsing is broken/disabled for release notes. Sorry about that, I'm chasing the source of a crash that's been bringing this website down for the last couple of days.
### Percentage functions
- New percentage function: "3 as % with 7, 8 and 9" (= 11.11%)
- This function gets the percentage of one number of a whole (including the number), a shorthand for "3 as % of (3 + 7 + 8 + 9)".
### Future date seeking mode
- Compound units of time are now supported in date seeking mode (for example "in 1 hour 20 minutes" will return a date 1 hour and 20 minutes from now)
### Automatic conversion mode
- Added a case for nanoseconds to automatically convert into milliseconds
### Bug fixes & improvements:
- Fixed a crash introduced in the previous build when doing certain date interval calculations
- Fixed a rare issue with fractions potentially being incorrectly formatted
- Fixed an issue with pitch to hz conversion not enough precision for rounded results in some cases
### Improvements
- Support for rates in lists (like "mean of 0.09615 $/kWh and 0.10965 $/kWh")
- The base unit for volume units is now `cubic meters` (rather than `liters`). This enables SoulverCore to return a result of meters for expressions like "200000 L / 125 m^2"
- Support for "dec" as a synonym of "decimal"
- Fixed a hang related to using 0 as in a list with the lcm function
- Fixed a bug with the future date seeking mode, for dates in the past that had a specified time of day
### Places
- Added new properties `country` and `city` on `Place`. These will return the associated country for a `City`, and the capital city of a `Country`. It will also return the associated city with an `Airport` place
- Added some additional places: Mauritius, French Guiana, Martinique, La Réunion, & Guadeloupe
### Units
- Support for generic custom units (defined not in terms of an existing unit)
- Use `undefined` as your `equivalentUnitIdentifier`
### Linear growth functions
- Linear growth functions can now omit the starting quantity (it will be assumed to be 0)
- For instance "time to $100 at $4 every hour" (= 25 hours)
### Misc
- CSS units (em, rem & px) will now always be formatted using a standard US decimal character (.) so they can be immediately pasted into CSS files.
- Phrases like "days left in 2024" now use round numbers
- Fixed an issue with a spaceless compound quantity of time not being correctly recognized, like "2hr1min"
- You can now convert timespans into "months and days"
## Currency symbols
- New `CurrencySymbolSettings` enum on `EngineCustomization`
- Set to `.automatic` (the default) for the most logical currency symbol settings for the current locale
- Added "tenges" as a synonym for Kazakhstani Tenges
## Bug fixes
- "tonne" now maps to metric ton, rather than short tons.
- iso8601 time stamps with sub-second components and negative timezone offsets are now recognized correctly.
- Fixed an issue with hex/binary/octal numbers not working with log functions
- Fixed an issue where raising area and volume units to fractional powers would not perform the correct operation
- Fixed an issued where single letter prefix currency symbols were not parsing correctly (like "R100", used in South Africa)
## Calendar Calculations
### Timespans
- Added support for time spans expressed in two units "in minutes and seconds", "in hours and minutes", "in days and hours", "in weeks and days"
- Support for "as time span" as a synonym for "as timespan"
- Timespans, rather than single time units, are now used after more operations on single quantities of time
- For example, "25 min / 12" = (2 min 5 second), "1h20m + 45m" = (2 hours 5 min)
- We now use fixed time units (weeks, days, minutes, etc), not variable ones (years, months), when "as timespan" is specified for the result
### Format dates using format patterns
- For example, "March 12, 2023 as EEEE, MMM d, yyyy" (= Sunday, Mar 12, 2023)
- Or "March 12, 2023 as MM/dd/yy" (= 03/12/23)
- The pattern language is defined by the [Unicode Technical Standard #35](https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns)
- Here is a good [cheat sheet](https://toolboxpro.app/blog/unicode-cheatsheet) (RIP Alex Hay)
### Timezone codes
- Added a new `TimezoneCodeCorrectionBehavior` enum that can be used on an `EngineFeatureFlags` on an `EngineCustomization`
- This includes a new option to only "correct" non-summer timezone codes
### Other
- Add support for dates with the form "13 March 23" (the year is assumed to be the (20)23, and the day 13)
- Workaround an issue in Foundation's `Calendar` which sometimes interprets "Feb 29" as an invalid date (even in a leap year)
## General
### Pounds & ounces
- New "Pounds & ounces" output format: "87 ounces" will return "5 lb 7 oz"
- Explicitly convert with "in pounds and ounces" or "in lb oz"
### Locales
- Fixed an issue introduced in 2.4.7 where the `.` symbol was not being correctly interpreted as a decimal point in locales like French & Russian, in which this symbol is not defined as either a decimal point or thousands separator
- Support for automatic 3 dp of accuracy in currency results, when used in locales like French and Russian: €12,995 - €1,747 = €11,248 (the result is 11, not 11 thousand)
### Other
- Support for applying SI scalars (`k`, `M`, `G`, etc) to sub-expressions (500)k and line references in `LineCollection`
- With the variable declarations feature flag disabled, expressions that include the `=` symbol will no longer return results
## Engine Configuration
### EngineFeatureFlags (note: possibly source breaking change)
- The `EngineFeatureFlags` object has been tidied up and certain flags removed
- `EngineFeatureFlags` had become a bit of a catch-all object over time, with many legacy properties. We felt it was time to make it more friendly for newcomer to the framework, and also more ergonomic for everyone
- It is unlikely you were using any of the removed feature flags. However, please email us or open a discussion a flag you were depending on is no longer available
### Commenting
- Added a new `CommentingOptions` object (set the `commentingOptions` property on `LineCollection`) to customize which commenting features you want to support in multi-line calculations
- `Calculator` no longer supports commenting features (they continue to be available on `LineCollection`)
### Thousands separator as decimal point
- A new property `misplacedThousandsSeparatorBehavior` on `EngineFeatureFlags` and can be set to control how numbers with thousands separators in the wrong position should be handled (`allow`, `disallow` or `interpretAsDecimalPoint`)
- With the `interpretAsDecimalPoint` option, Europeans that use `,` as a decimal separator can now also use `.` in unambiguous cases (like "1,3 + 1.3 = 2,6")
### Number formatting
- Crypto-currencies no longer round to 2 dp (they're not regular currencies to exhibit this behaviour)
- Numbers formatted with SI notation now respect the `dp` property in `FormattingPreferences`
- For Europeans, SoulverCore will now automatically show 3 dp of accuracy in results when 3 dp is also used in a currency expression (for example "€12,995 - €1,747 = €11,248"). Note that this result is **not** eleven thousand
### Calendar calculations
- Support for time interval expressions with year stamps, like `today - 1973`
### Lists
- Support for subexpressions inside lists, like "max (3+4), 5, 3" (= 7)
### Bug fixes
- Workaround an issue in Foundation where NSDecimalPower() can return incorrect results (like for `0.1^1000`)
- Fixed an issue with future date seeking mode, when inputing unambiguous dates earlier in the year
### Timezones
- Added some missing timezones for some small countries (Brunei, the Maldives, and some others)
- You can use the "Europe" timezone (like "time in Europe"). We fetch the time in Brussels (often considered the capital of Europe)
### Sinh function
- Fixed an issue with the `sinh` function incorrectly calling `cosh` instead
- Fixed an issue where `sinh(10000)` could crash SoulverCore
### Special days in calendar calculations
This version adds support for special widely celebrated cultural events in calendar calculations, including:
- Christmas eve
- Christmas day
- Boxing day
- New year's eve
- New year's day
- Good Friday
- Easter Sunday
- St. Valentine's day
- Halloween
- Black Friday
- Thanksgiving
- Chinese New Year
- Ramadan (start and end)
Use special days in calendar calculations, like "days until xmas", "black friday last year", "chinese new year 2025", "this easter", etc.
They are especially helpful for working with events like Easter, Ramadan and Chinese New Year that tend to change their date every year.
### Timezones
- Support for short US timezone aliases: "pt" (pacific time), "mt" (mountain time), "ct" (central time) and "et" (eastern time).
- Added missing "Nevada" & "Las Vegas" timezones
- Fixed an issue where "New York" was referring to the state ("New York State"), rather than the city
### Scheduling
- Support "Friday at 18" style expressions in future date seeking mode (with the am/pm omitted, and support for 24 hours)
- 1-5 will assume pm, and 6-11 am, i.e "Friday at 7" will be interpreted as 7am.
### Operations on lists
- Added "min" and "max" functions: "min of 5, 2 and 7" (= 2)
- You can now use gcd and lcm functions on lists: "gcd 10, 20, 5" (= 5)
### CSS
- Rem/em/px units are formatted without a space now (i.e "3em"), so they can be immediately pasted into CSS files
### General functions
- Added a phrase to detect whether a number is prime: "is 7 prime" (= true)
- Added a clamp function (value, min, max): "clamp 10 5 7" (= 7), or more verbosely "clamp 10 between 5 and 7)
### Scientific notation
- Support 1.0E+04 style scientific notation (with an uppercase E, previously only lowercase e was supported).
### Currency Formatting Preferences
- A new struct that can be used for more fine-grain control over how currencies are formatted
- For example, you can use the new `showTrailingZeros` property to display a result of `$1.00` as `$1`. This was not possible in previous releases.
### Bug fixes
- Fixed an issue that required Romanian Leu (RON) to be uppercased
- Kilowatts * hours now correctly produces results in kilowatt hours: 1,800 kW * hours (= 1800 kWh)
- Fixed an issue with multiplying MHz & GHz by time
### Units
- Added the `rem` css unit
- Added a `fontBaseSize` property on `EngineCustomization` that can be used to customize the definition of the `rem` and `em` units
### Dates & Times
- Added a time ago in location phrase, i.e. "4 hours ago in nyc"
### Bug fixes
- Fixed the GPS location of Birmingham
### Error handling
- There is a new `impreciseResult` error type.
Numbers larger than 37 significant digits cannot fit into Foundation's `Decimal` type, and doing certain operations on them which require more precision than this will fail (like mod)
### Utilities
- New utility classes for doing operations on `CalculationResult` objects (adding, subtracting, negating, etc)
### Constants
- Additional constants: "phi" (golden ratio), & "tau" (2π)
### Bases
- Support for octal (base-8) numbers, i.e: "0o120707 to decimal" (= 41231)
### Scientific notation
- Convert numbers into scientific notation using "in scientific notation", or "in sci", like "10,500 in sci" (= 1.05e4)
- Additional notation thresholds have been added to ``SIThreshold``
### Converting length to pixels
- New function for length to pixels conversion:
- "1 cm in px @ 326 ppi" (= 128px)
### API changes
- Some options on ``EngineFeatureFlags`` have been moved into ``LineCollection``, as they only apply to calculations over multiple lines.