Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lucía Cortés CapacityUnitEnum 5x #3197

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Lucía Cortés CapacityUnitEnum 5x #3197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb1e1d5
CapacityUnitEnum 5x
LuciaCortesTH Oct 25, 2024
520257b
Merge branch '5.x.x' into lcortes_auth0_65c35d8032527345d0bc9560-Capa…
JayasriR Nov 11, 2024
a713c4f
Update RELEASE.md
PayalKhanna Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 6 additions & 156 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,164 +1,14 @@
# *CDM Model - Equity Product Qualification and Validation*
# _CDM Model - CapacityUnit Enum_

_Background_

This release contains modifications required to accomodate Equity and Exotic Products under individual Asset Classes

_What is being released?_

This release creates following modifications:
- a new qualification function `Qualify_Equity_OtherOption` to add qualification for Exotic Options
```
func Qualify_Equity_OtherOption: <"Qualifies a product with properties of an Exotic Option as Equity Option (Other)">
[qualification Product]
inputs:
economicTerms EconomicTerms (1..1)
output:
is_product boolean (1..1)
[synonym ISDA_Taxonomy_v1 value "Qualify_EquityOther"]
[synonym ISDA_Taxonomy_v2 value "Qualify_EquityOther"]
set is_product:
Qualify_AssetClass_Equity(economicTerms) = True
and economicTerms -> payout -> optionPayout only exists
and economicTerms -> nonStandardisedTerms = True

```
- changes in existing options to avoid duplicate qualification of options
```
e.g.
func Qualify_EquityOption_PriceReturnBasicPerformance_SingleName
now contains additional clause
and (if economicTerms -> nonStandardisedTerms exists then economicTerms -> nonStandardisedTerms = False else True)
```

- modification in FpML conditions `FpML_ird_9` and `FpML_ird_29`
```
condition FpML_ird_9: <"FpML validation rule ird-9 - If calculationPeriodAmount/calculation/compoundingMethod exists, then resetDates must exist.">
if compoundingMethod exists then resetDates exists

condition FpML_ird_29: <"FpML validation rule ird-29 - If compoundingMethod exists, then fixedRateSchedule must not exist.">
if compoundingMethod exists
then rateSpecification -> fixedRate is absent
```
- relaxation of cardinality rule for `expirationTime`
```
expirationTime BusinessCenterTime (0..1) <"The latest time for exercise on expirationDate.">

condition ExpirationTimeChoice: <"Condition to validate the existence of correlation between expirationTime and expirationTimeType">
ExpirationTimeType(expirationTime, expirationTimeType)

func ExpirationTimeType: <"Conditional Validation function to check the existence of correlation between expiration Time and expiration Time Type.">
inputs:
expirationTime BusinessCenterTime (0..1)
expirationTimeType ExpirationTimeTypeEnum (0..1)
output:
success boolean (1..1)

set success:
(if expirationTime exists and expirationTimeType exists then expirationTimeType = ExpirationTimeTypeEnum -> SpecificTime)
and
(if expirationTimeType exists and expirationTimeType = ExpirationTimeTypeEnum -> SpecificTime then expirationTime exists)

```
- modification to `Qualify_AssetClass_Commodity`
```
addition of clause:
or (economicTerms -> payout -> forwardPayout, economicTerms -> payout -> commodityPayout) only exists
or economicTerms -> payout -> forwardPayout only exists)
```
_Review Directions_

In Rosetta, select the Textual Browser and inspect the changes identified above.

Changes can be reviewed in PR: [#3163](https://github.com/finos/common-domain-model/issues/3163)


# *CDM Model - RoundToPrecisionRemoveTrailingZeros Function*

_Background_

This release contains a new function for `RoundToPrecisionRemoveTrailingZeros` function, as described in issue [#2915](https://github.com/finos/common-domain-model/issues/2915#issuecomment-2393577467).

_What is being released?_

This release creates the new function `cdm.base.math.RoundToPrecisionRemoveTrailingZeros` to not add any trailing 0's in the end if they do not already exist.

```
ffunc RoundToPrecisionRemoveTrailingZeros: <"Round a number to the supplied precision, using the supplied rounding direction.">
inputs:
value number (1..1) <"The original (unrounded) number.">
precision int (1..1) <"The number of decimal digits of precision.">
roundingMode RoundingDirectionEnum (1..1) <"The method of rounding (up/down/nearest).">
output:
roundedValue number (1..1) <"The value to the desired precision">

condition NonNegativePrecision: <"The number of decimal digits of precision should be greater than or equal to zero.">
precision >= 0
```

The following examples show the function behaviour:
- `RoundToPrecisionRemoveTrailingZeros(1023.123456789, 5, RoundingDirectionEnum -> NEAREST, true)` = 1023.12346
- `RoundToPrecisionRemoveTrailingZeros(1023.12000, 5, RoundingDirectionEnum -> NEAREST, true)` = 1023.12
- `RoundToPrecisionRemoveTrailingZeros(1023, 5, RoundingDirectionEnum -> NEAREST, true)` = 1023
- `RoundToPrecisionRemoveTrailingZeros(999999999, 4, RoundingDirectionEnum -> NEAREST, true)` = 999999999

This would is new function, so there are no compatibility issues.

_Review Directions_

In Rosetta, select the Textual Browser and inspect the changes identified above.

Changes can be reviewed in PR [#3181](https://github.com/finos/common-domain-model/pull/3181)

# *CDM Model - RoundToSignificantFigures Function*

_Background_

This release contains a new function for `RoundToSignificantFigures` function, as described in issue [#3154](https://github.com/finos/common-domain-model/issues/3154).

_What is being released?_

This release creates the new function `cdm.base.math.RoundToSignificantFigures` to round to the significant number of decimal places.

```
func RoundToSignificantFigures: <"Round a number to the supplied significant figures, using the supplied rounding direction.">
inputs:
value number (1..1) <"The original (unrounded) number.">
significantFigures int (1..1) <"The number of significant figures.">
roundingMode RoundingDirectionEnum (1..1) <"The method of rounding (up/down/nearest).">
output:
roundedValue number (1..1) <"The value to the desired number of significant figures.">

condition NonZeroSignificantFigures: <"The number of significant figures should be greater than zero.">
significantFigures > 0
```

The following examples show the function behaviour:
- `RoundToSignificantFigures(1023.123456789, 5, RoundingDirectionEnum -> NEAREST)` = 1023.1
- `RoundToSignificantFigures(1023.123456789, 5, RoundingDirectionEnum -> UP)` = 1023.2
- `RoundToSignificantFigures(1023.123456789, 5, RoundingDirectionEnum -> DOWN)` = 1023.1
- `RoundToSignificantFigures(1023.123456789, 1, RoundingDirectionEnum -> NEAREST)` = 1000
- `RoundToSignificantFigures(1023.1, 7, RoundingDirectionEnum -> NEAREST)` = 1023.1

This is a new function, so there are no compatibility issues.

_Review Directions_

In Rosetta, select the Textual Browser and inspect the changes identified above.

Changes can be reviewed in PR [#3180](https://github.com/finos/common-domain-model/pull/3180)

# _Infrastructure - Dependency Update_
In has been seen that in the ExternalUnitOfMeasure1Code from the 2Q2024 ISO External CodeSets v1, the unity Joule is supported in the Enum. However, in CDM this is not the case, as it does not appear anywhere in the CapacityUnitEnum. Therefore, the Joule unit of measure will be added to the CapacityUnitEnum for completeness and to align with 2Q2024 ISO External CodeSets v1, for versions 5 and 6 of CDM.

_What is being released?_

This release updates the `DSL` dependency.
- Updated `CapacityUnitEnum` in cdm.base.math

Version updates include:
- `DSL` 9.19.0: support for `switch` operation on `choice` types. For further details see DSL release notes: https://github.com/finos/rune-dsl/releases/tag/9.19.0
- `DSL` 9.20.0: support for passing metadata to functions and highlighting fixes. For further details see DSL release notes: https://github.com/finos/rune-dsl/releases/tag/9.20.0
_Enumerations_

_Review directions_
- Updated `CapacityUnitEnum` by adding 'J' to support Joule unit

The `DSL` 9.19.0 changes can be reviewed in PR: [#3153](https://github.com/finos/common-domain-model/pull/3153)
The `DSL` 9.20.0 changes can be reviewed in PR: [#3192](https://github.com/finos/common-domain-model/pull/3192)
The changes can be reviewed in PR: [#3197](https://github.com/finos/common-domain-model/pull/3197)
1 change: 1 addition & 0 deletions rosetta-source/src/main/rosetta/base-math-enum.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ enum CapacityUnitEnum: <"Provides enumerated values for capacity units, generall
ISOBTU <"Denotes an ISO British Thermal Unit as a standard unit.">
ISOMBTU <"Denotes a Thousand ISO British Thermal Unit as a standard unit.">
ISOMMBTU <"Denotes a Million ISO British Thermal Unit as a standard unit.">
J <"Denotes a Joule as a standard unit.">
ISOTHM <"Denotes an ISO Thermal Unit as a standard unit.">
KG <"Denotes a Kilogram as a standard unit.">
KL <"Denotes a Kilolitre as a standard unit.">
Expand Down
Loading