diff --git a/Documentation/.vitepress/cache/deps/_metadata.json b/Documentation/.vitepress/cache/deps/_metadata.json index 9c62921..c34ee45 100644 --- a/Documentation/.vitepress/cache/deps/_metadata.json +++ b/Documentation/.vitepress/cache/deps/_metadata.json @@ -1,11 +1,11 @@ { - "hash": "c32c40ee", - "browserHash": "8bb4da6e", + "hash": "8c80eb0e", + "browserHash": "11652ff9", "optimized": { "vue": { "src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js", "file": "vue.js", - "fileHash": "a4a8559a", + "fileHash": "363b117a", "needsInterop": false } }, diff --git a/Documentation/.vitepress/config.js b/Documentation/.vitepress/config.js index 409184d..2ee9f67 100644 --- a/Documentation/.vitepress/config.js +++ b/Documentation/.vitepress/config.js @@ -186,10 +186,18 @@ function sidebar() { text: 'Distances', link: '/core/converters/distances' }, + { + text: 'Energies', + link: '/core/converters/energies' + }, { text: 'Masses', link: '/core/converters/masses' }, + { + text: 'Speeds', + link: '/core/converters/speeds' + }, { text: 'Storage', link: '/core/converters/storage' diff --git a/Documentation/core/converters/energies.md b/Documentation/core/converters/energies.md new file mode 100644 index 0000000..7b130e1 --- /dev/null +++ b/Documentation/core/converters/energies.md @@ -0,0 +1,66 @@ +# Energies +This page is about the `Energies` class available in [`PeyrSharp.Core.Converters`](/core/converters.md). +You can find here all of its methods. + +::: info +This class is `static`. +::: + +## Compatibility + +The `Energies` class is part of the `PeyrSharp.Core` module, which is compatible with all of these frameworks and platforms: + +| Package/Platform | Windows | macOS | Linux + others | +|------------------ |--------- |------- |---------------- | +| Core | ✅ | ✅ | ✅ | +| **Framework** | **.NET 5** | **.NET 6** | **.NET 7** | +| Core | ✅ | ✅ | ✅ | + +## Methods +### CaloriesToJoules(calories) +#### Definition + +Converts calories to joules. + +#### Arguments + +| Type | Name | Meaning | +|----------|------------|-----------------------------------------------------| +| `double` | `calories` | The amount of energy in calories to be converted. | + +#### Returns + +The equivalent amount of energy in joules. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double calories = 100.0; +double joules = Energies.CaloriesToJoules(calories); +~~~ + +### JoulesToCalories(joules) +#### Definition + +Converts joules to calories. + +#### Arguments + +| Type | Name | Meaning | +| -------- | -------- | ---------------------------- | +| `double` | `joules` | The amount of energy in joules. | + +#### Returns + +The equivalent amount of energy in calories. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double joules = 1000.0; +double calories = Energies.JoulesToCalories(joules); +~~~ diff --git a/Documentation/core/converters/speeds.md b/Documentation/core/converters/speeds.md new file mode 100644 index 0000000..caaf839 --- /dev/null +++ b/Documentation/core/converters/speeds.md @@ -0,0 +1,217 @@ +# Speeds +This page is about the `Speeds` class available in [`PeyrSharp.Core.Converters`](/core/converters.md). +You can find here all of its methods. + +::: info +This class is `static`. +::: + +## Compatibility + +The `Speeds` class is part of the `PeyrSharp.Core` module, which is compatible with all of these frameworks and platforms: + +| Package/Platform | Windows | macOS | Linux + others | +|------------------ |--------- |------- |---------------- | +| Core | ✅ | ✅ | ✅ | +| **Framework** | **.NET 5** | **.NET 6** | **.NET 7** | +| Core | ✅ | ✅ | ✅ | + +## Methods +### KnotsToKilometersPerHour(knots) +#### Definition + +Converts knots to kilometers per hour. + +#### Arguments + +| Type | Name | Meaning | +|----------- |----------- |--------------------------------- | +| `double` | `knots` | The speed in knots. | + +#### Returns + +The equivalent speed in kilometers per hour. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInKnots = 20.0; +double speedInKilometersPerHour = Speeds.KnotsToKilometersPerHour(speedInKnots); +Console.WriteLine($"{speedInKnots} knots is equivalent to {speedInKilometersPerHour} km/h"); +~~~ + +### KilometersPerHourToKnots(kilometersPerHour) + +#### Definition + +Converts kilometers per hour to knots. + +#### Arguments + +| Type | Name | Description | +|----------- |---------------------- |--------------------------------- | +| `double` | `kilometersPerHour` | The speed in kilometers per hour. | + +#### Returns + +The equivalent speed in knots. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInKilometersPerHour = 40.0; +double speedInKnots = Speeds.KilometersPerHourToKnots(speedInKilometersPerHour); +Console.WriteLine($"{speedInKilometersPerHour} km/h is equivalent to {speedInKnots} knots"); +~~~ + +### KnotsToMilesPerHour(knots) + +#### Definition +Converts knots to miles per hour. + +#### Arguments +| Type | Name | Description | +|-----------|-------|--------------------| +| `double` | `knots` | The speed in knots. | + +#### Returns +The equivalent speed in miles per hour. + +#### Usage +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInKnots = 20.0; +double speedInMilesPerHour = Speeds.KnotsToMilesPerHour(speedInKnots); +Console.WriteLine($"{speedInKnots} knots is equivalent to {speedInMilesPerHour} mph"); +~~~ + +### MilesPerHourToKnots(milesPerHour) +#### Definition + +Converts miles per hour to knots. + +#### Arguments + +| Type | Name | Description | +|----------- |--------------- |--------------------------- | +| `double` | `milesPerHour` | The speed in miles per hour.| + +#### Returns + +The equivalent speed in knots. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInMilesPerHour = 60.0; +double speedInKnots = Speeds.MilesPerHourToKnots(speedInMilesPerHour); +Console.WriteLine($"{speedInMilesPerHour} miles/hour is equivalent to {speedInKnots} knots"); +~~~ + +### KilometersPerHourToMetersPerSecond(kilometersPerHour) + +#### Definition + +Converts kilometers per hour to meters per second. + +#### Arguments + +| Type | Name | Description | +|---------------------------|---------------------|-----------------------------------------------------| +| `double` | `kilometersPerHour` | The speed in kilometers per hour. | + +#### Returns + +The equivalent speed in meters per second. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInKilometersPerHour = 100.0; +double speedInMetersPerSecond = Speeds.KilometersPerHourToMetersPerSecond(speedInKilometersPerHour); +Console.WriteLine($"{speedInKilometersPerHour} km/h is equivalent to {speedInMetersPerSecond} m/s"); +~~~ + +### MetersPerSecondToKilometersPerHour(metersPerSecond) +#### Definition + +Converts meters per second to kilometers per hour. + +#### Arguments + +| Type | Name | Meaning | +|---------------|-------------------|-----------------------------| +| `double` | `metersPerSecond` | The speed in meters per second. | + +#### Returns + +The equivalent speed in kilometers per hour. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInMetersPerSecond = 10.0; +double speedInKilometersPerHour = Speeds.MetersPerSecondToKilometersPerHour(speedInMetersPerSecond); +Console.WriteLine($"{speedInMetersPerSecond} m/s is equivalent to {speedInKilometersPerHour} km/h"); +~~~ + +### MilesPerHourToKilometersPerHour(milesPerHour) +#### Definition + +Converts miles per hour to kilometers per hour. + +#### Arguments + +| Type | Name | Description | +|----------- |--------------- |-------------------------------- | +| `double` | `milesPerHour` | The speed in miles per hour. | + +#### Returns + +The equivalent speed in kilometers per hour. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInMilesPerHour = 60.0; +double speedInKilometersPerHour = Speeds.MilesPerHourToKilometersPerHour(speedInMilesPerHour); +Console.WriteLine($"{speedInMilesPerHour} mph is equivalent to {speedInKilometersPerHour} km/h"); +~~~ + +### KilometersPerHourToMilesPerHour(kilometersPerHour) +#### Definition + +Converts kilometers per hour to miles per hour. + +#### Arguments + +| Type | Name | Description | +|----------- |--------------------- |--------------------------------------- | +| `double` | `kilometersPerHour` | The speed in kilometers per hour. | + +#### Returns + +The equivalent speed in miles per hour. + +#### Usage + +~~~ c# +using PeyrSharp.Core.Converters; + +double speedInKilometersPerHour = 50.0; +double speedInMilesPerHour = Speeds.KilometersPerHourToMilesPerHour(speedInKilometersPerHour); +Console.WriteLine($"{speedInKilometersPerHour} km/h is equivalent to {speedInMilesPerHour} mph"); +~~~ \ No newline at end of file diff --git a/Documentation/extensions/string.md b/Documentation/extensions/string.md index c481a94..ae822e1 100644 --- a/Documentation/extensions/string.md +++ b/Documentation/extensions/string.md @@ -215,3 +215,26 @@ string str = "test"; string upper = str.ToUpperAt(); // Uppercase the first letter of the string // upper = "Test" ~~~ +### Reverse(input) +#### Definition + +Reverses a `string`. + +#### Arguments + +| Type | Name | Description | +|------------|---------|----------------------| +| `string` | `input` | The string to reverse. | + +#### Returns + +A `string` representing the reversed input. + +#### Usage + +~~~ c# +using PeyrSharp.Extensions; + +string reversed = "Hello, world!".Reverse(); +// Output: "!dlrow ,olleH" +~~~ \ No newline at end of file diff --git a/Documentation/reference.md b/Documentation/reference.md index 8f5faec..7d2a616 100644 --- a/Documentation/reference.md +++ b/Documentation/reference.md @@ -10,7 +10,9 @@ The reference of PeyrSharp. - [HEX](/core/converters/colors/hex.md) - [HSV](/core/converters/colors/hsv.md) - [Distances](/core/converters/distances.md) + - [Energies](/core/converters/energies.md) - [Masses](/core/converters/masses.md) + - [Speeds](/core/converters/speeds.md) - [Storage](/core/converters/storage.md) - [Temperatures](/core/converters/temperatures.md) - [Time](/core/converters/time.md) diff --git a/docs/404.html b/docs/404.html index 4b08381..87d0a51 100644 --- a/docs/404.html +++ b/docs/404.html @@ -6,15 +6,15 @@
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.