From 0ed93bd4bf7557d5fc257964c2e3039e67fe4af8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Peyronnet?= Date: Sat, 6 May 2023 08:24:12 +0200 Subject: [PATCH 01/14] Added Devyus references --- .licenserc.json | 29 +- Documentation/.vitepress/config.js | 710 ++-- Documentation/package.json | 4 +- PeyrSharp.Core/Converters/Angle.cs | 2 +- PeyrSharp.Core/Converters/Distances.cs | 2 +- PeyrSharp.Core/Converters/Energies.cs | 8 +- PeyrSharp.Core/Converters/HEX.cs | 2 +- PeyrSharp.Core/Converters/HSV.cs | 2 +- PeyrSharp.Core/Converters/Masses.cs | 2 +- PeyrSharp.Core/Converters/RGB.cs | 2 +- PeyrSharp.Core/Converters/Speeds.cs | 8 +- PeyrSharp.Core/Converters/Storage.cs | 2 +- PeyrSharp.Core/Converters/Temperatures.cs | 2 +- PeyrSharp.Core/Converters/Time.cs | 2 +- PeyrSharp.Core/Converters/Volumes.cs | 2 +- PeyrSharp.Core/Crypt.cs | 2 +- PeyrSharp.Core/Guid.cs | 2 +- PeyrSharp.Core/Internet.cs | 2 +- PeyrSharp.Core/Maths/Algebra.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Circle.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Cone.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Cube.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Cylinder.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Diamond.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Hexagon.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Pyramid.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Rectangle.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Sphere.cs | 2 +- PeyrSharp.Core/Maths/Geometry/Triangle.cs | 2 +- PeyrSharp.Core/Maths/Percentages.cs | 2 +- PeyrSharp.Core/Maths/Proba.cs | 2 +- PeyrSharp.Core/Maths/Stats.cs | 4 +- PeyrSharp.Core/Maths/Trigonometry.cs | 2 +- PeyrSharp.Core/Password.cs | 2 +- PeyrSharp.Core/PeyrSharp.Core.csproj | 2 +- PeyrSharp.Enums/ControlAlignment.cs | 2 +- PeyrSharp.Enums/LogLevel.cs | 2 +- PeyrSharp.Enums/OperatingSystems.cs | 2 +- PeyrSharp.Enums/PasswordPresets.cs | 2 +- PeyrSharp.Enums/PasswordStrength.cs | 2 +- PeyrSharp.Enums/PeyrSharp.Enums.csproj | 2 +- PeyrSharp.Enums/StatusCodes.cs | 2 +- PeyrSharp.Enums/StorageUnits.cs | 2 +- PeyrSharp.Enums/SystemThemes.cs | 2 +- PeyrSharp.Enums/TimeUnits.cs | 2 +- PeyrSharp.Enums/TriangleSides.cs | 2 +- PeyrSharp.Enums/WindowsVersion.cs | 2 +- PeyrSharp.Env/FileSys.cs | 2 +- PeyrSharp.Env/Logger.cs | 2 +- PeyrSharp.Env/PeyrSharp.Env.csproj | 2 +- PeyrSharp.Env/Sys.cs | 2 +- PeyrSharp.Env/Update.cs | 2 +- .../HEXInvalidValueException.cs | 2 +- .../InvalidGuidLenghtException.cs | 2 +- .../PeyrSharp.Exceptions.csproj | 2 +- .../RGBInvalidValueException.cs | 2 +- PeyrSharp.Extensions/ArrayExtensions.cs | 2 +- PeyrSharp.Extensions/DoubleExtensions.cs | 2 +- PeyrSharp.Extensions/IntExtensions.cs | 2 +- .../PeyrSharp.Extensions.csproj | 2 +- PeyrSharp.Extensions/StringExtensions.cs | 2 +- .../PeyrSharp.UiHelpers.csproj | 2 +- PeyrSharp.UiHelpers/ScreenHelpers.cs | 2 +- PeyrSharp.UiHelpers/WinFormsHelpers.cs | 2 +- PeyrSharp.UiHelpers/WpfHelpers.cs | 2 +- PeyrSharp/PeyrSharp.cs | 2 +- PeyrSharp/PeyrSharp.csproj | 2 +- docs/404.html | 485 ++- docs/core.html | 1705 ++++++++- docs/core/converters.html | 1724 ++++++++- docs/core/converters/angle.html | 1823 +++++++++- docs/core/converters/colors/hex.html | 1921 +++++++++- docs/core/converters/colors/hsv.html | 1872 +++++++++- docs/core/converters/colors/rgb.html | 2014 ++++++++++- docs/core/converters/distances.html | 1955 +++++++++- docs/core/converters/energies.html | 1842 +++++++++- docs/core/converters/masses.html | 1825 +++++++++- docs/core/converters/speeds.html | 2288 +++++++++++- docs/core/converters/storage.html | 2215 +++++++++++- docs/core/converters/temperatures.html | 1823 +++++++++- docs/core/converters/time.html | 2184 +++++++++++- docs/core/converters/volumes.html | 1823 +++++++++- docs/core/crypt.html | 2133 ++++++++++- docs/core/guid-options.html | 1986 ++++++++++- docs/core/guid.html | 1987 ++++++++++- docs/core/internet.html | 2178 +++++++++++- docs/core/maths.html | 1769 +++++++++- docs/core/maths/algebra.html | 2227 +++++++++++- docs/core/maths/geometry.html | 1737 ++++++++- docs/core/maths/geometry/circle.html | 1873 +++++++++- docs/core/maths/geometry/cone.html | 1928 +++++++++- docs/core/maths/geometry/cube.html | 2216 +++++++++++- docs/core/maths/geometry/cylinder.html | 1979 ++++++++++- docs/core/maths/geometry/diamond.html | 2074 ++++++++++- docs/core/maths/geometry/hexagon.html | 1922 +++++++++- docs/core/maths/geometry/pyramid.html | 2374 ++++++++++++- docs/core/maths/geometry/rectangle.html | 2031 ++++++++++- docs/core/maths/geometry/sphere.html | 1926 +++++++++- docs/core/maths/geometry/triangle.html | 2431 ++++++++++++- docs/core/maths/percentages.html | 1975 ++++++++++- docs/core/maths/proba.html | 1807 +++++++++- docs/core/maths/stats.html | 1959 +++++++++- docs/core/maths/trigonometry.html | 1968 ++++++++++- docs/core/password.html | 2033 ++++++++++- docs/enumerations.html | 3139 ++++++++++++++++- docs/env.html | 872 ++++- docs/env/filesys.html | 1952 +++++++++- docs/env/logger.html | 1150 +++++- docs/env/system.html | 1602 ++++++++- docs/env/update.html | 1033 +++++- docs/exceptions.html | 2354 +++++++++++- docs/extensions.html | 866 ++++- docs/extensions/array.html | 1227 ++++++- docs/extensions/double.html | 1936 +++++++++- docs/extensions/int.html | 1219 ++++++- docs/extensions/string.html | 1613 ++++++++- docs/get-started.html | 2464 ++++++++++++- docs/index.html | 614 +++- docs/intro.html | 827 ++++- docs/reference.html | 2390 ++++++++++++- docs/ui-helpers.html | 851 ++++- docs/ui-helpers/screen.html | 1140 +++++- docs/ui-helpers/winforms.html | 1078 +++++- docs/ui-helpers/wpf.html | 916 ++++- 124 files changed, 100523 insertions(+), 1617 deletions(-) diff --git a/.licenserc.json b/.licenserc.json index 7bfb55f..a9f6052 100644 --- a/.licenserc.json +++ b/.licenserc.json @@ -1,18 +1,13 @@ { - "**/*.cs": [ - "/*", - "MIT License", - "", - "Copyright (c) Léo Corporation" - ], - "ignore": [ - "**/*.Designer.cs", - "PeyrSharp/Properties/", - "PeyrSharp.Core/obj/", - "PeyrSharp.Enums/obj/", - "PeyrSharp.Exceptions/obj/", - "PeyrSharp.UiHelpers/obj/", - "PeyrSharp.Env/obj/", - "PeyrSharp/obj/" - ] -} \ No newline at end of file + "**/*.cs": ["/*", "MIT License", "", "Copyright (c) Devyus"], + "ignore": [ + "**/*.Designer.cs", + "PeyrSharp/Properties/", + "PeyrSharp.Core/obj/", + "PeyrSharp.Enums/obj/", + "PeyrSharp.Exceptions/obj/", + "PeyrSharp.UiHelpers/obj/", + "PeyrSharp.Env/obj/", + "PeyrSharp/obj/" + ] +} diff --git a/Documentation/.vitepress/config.js b/Documentation/.vitepress/config.js index 2ee9f67..9979310 100644 --- a/Documentation/.vitepress/config.js +++ b/Documentation/.vitepress/config.js @@ -1,368 +1,372 @@ export default { - title: 'PeyrSharp', - logo: '/logo.png', - description: 'A C# library designed to make developers\' job easier.', - lastUpdated: true, - outDir: '../docs', - head: [['link', { rel: 'icon', href: '/logo.png' }]], - themeConfig: { - nav: [ - { text: 'Guide', link: '/get-started' }, - { text: 'Reference', link: '/reference' }, - ], - repo: 'Leo-Corporation/PeyrSharp', - docsDir: 'documentation', - docsBranch: 'main', - editLink: { - pattern: 'https://github.com/Leo-Corporation/PeyrSharp/edit/main/Documentation/:path', - text: 'Edit this page on GitHub' - }, - footer: { - message: 'Released under the MIT License.', - copyright: 'Copyright © 2023 Devyus/Léo Corporation' - }, - algolia: { - appId: 'JVAJ1JZ6HO', - apiKey: '0ef6a29a84fc5698ce54fde4381bf281', - indexName: 'peyrsharp' - }, - socialLinks: [ - { - icon: 'github', link: 'https://github.com/Leo-Corporation/PeyrSharp' - }, - { - icon: 'twitter', link: 'https://twitter.com/LeoCorpNews' - }, - { - icon: 'youtube', link: 'https://www.youtube.com/channel/UC283Dtf6EJ8eKfRoo0ISmqg' - } - ], - outline: [1, 3], - sidebar: { - '/core/': sidebar(), - 'core': sidebar(), - 'get-started': superSidebar(), - '/ui-helpers/': uiHelpersSidebar(), - "ui-helpers": uiHelpersSidebar(), - '/env/': envSidebar(), - 'env': envSidebar(), - '/extensions/': extSidebar(), - '/extension': extSidebar(), - 'reference': superSidebar(), - 'enumerations': superSidebar(), - 'exceptions': superSidebar() - } - } -} + title: "PeyrSharp", + logo: "/logo.png", + description: "A C# library designed to make developers' job easier.", + lastUpdated: true, + outDir: "../docs", + head: [["link", { rel: "icon", href: "/logo.png" }]], + themeConfig: { + nav: [ + { text: "Guide", link: "/get-started" }, + { text: "Reference", link: "/reference" }, + ], + repo: "Leo-Corporation/PeyrSharp", + docsDir: "documentation", + docsBranch: "main", + editLink: { + pattern: + "https://github.com/Leo-Corporation/PeyrSharp/edit/main/Documentation/:path", + text: "Edit this page on GitHub", + }, + footer: { + message: "Released under the MIT License.", + copyright: "Copyright © 2023 Devyus", + }, + algolia: { + appId: "JVAJ1JZ6HO", + apiKey: "0ef6a29a84fc5698ce54fde4381bf281", + indexName: "peyrsharp", + }, + socialLinks: [ + { + icon: "github", + link: "https://github.com/Leo-Corporation/PeyrSharp", + }, + { + icon: "twitter", + link: "https://twitter.com/LeoCorpNews", + }, + { + icon: "youtube", + link: "https://www.youtube.com/channel/UC283Dtf6EJ8eKfRoo0ISmqg", + }, + ], + outline: [1, 3], + sidebar: { + "/core/": sidebar(), + core: sidebar(), + "get-started": superSidebar(), + "/ui-helpers/": uiHelpersSidebar(), + "ui-helpers": uiHelpersSidebar(), + "/env/": envSidebar(), + env: envSidebar(), + "/extensions/": extSidebar(), + "/extension": extSidebar(), + reference: superSidebar(), + enumerations: superSidebar(), + exceptions: superSidebar(), + }, + }, +}; function superSidebar() { - return [ - { - text: 'Core', - collapsed: false, - items: sidebar() - }, - ...envSidebar(), - { - text: 'Enums', - collapsed: false, - items: [ - { - text: 'Home', - link: '/enumerations' - } - ] - }, - { - text: 'Exceptions', - collapsed: false, - items: [ - { - text: 'Home', - link: '/exceptions' - } - ] - }, - ...extSidebar(), - ...uiHelpersSidebar() - ] + return [ + { + text: "Core", + collapsed: false, + items: sidebar(), + }, + ...envSidebar(), + { + text: "Enums", + collapsed: false, + items: [ + { + text: "Home", + link: "/enumerations", + }, + ], + }, + { + text: "Exceptions", + collapsed: false, + items: [ + { + text: "Home", + link: "/exceptions", + }, + ], + }, + ...extSidebar(), + ...uiHelpersSidebar(), + ]; } function extSidebar() { - return [ - { - text: 'Extensions', - collapsed: false, - items: [ - { - text: 'Home', - link: '/extensions' - }, - { - text: 'Array', - link: '/extensions/array' - }, - { - text: 'Double', - link: '/extensions/double' - }, - { - text: 'Int', - link: '/extensions/int' - }, - { - text: 'String', - link: '/extensions/string' - } - ] - } - ] + return [ + { + text: "Extensions", + collapsed: false, + items: [ + { + text: "Home", + link: "/extensions", + }, + { + text: "Array", + link: "/extensions/array", + }, + { + text: "Double", + link: "/extensions/double", + }, + { + text: "Int", + link: "/extensions/int", + }, + { + text: "String", + link: "/extensions/string", + }, + ], + }, + ]; } function envSidebar() { - return [ - { - text: 'Env', - collapsed: false, - items: [ - { - text: 'Home', - link: '/env' - }, - { - text: 'FileSys', - link: '/env/filesys' - }, - { - text: 'Logger', - link: '/env/logger' - }, - { - text: 'Sys', - link: '/env/system' - }, - { - text: 'Update', - link: '/env/update' - } - ] - } - ] + return [ + { + text: "Env", + collapsed: false, + items: [ + { + text: "Home", + link: "/env", + }, + { + text: "FileSys", + link: "/env/filesys", + }, + { + text: "Logger", + link: "/env/logger", + }, + { + text: "Sys", + link: "/env/system", + }, + { + text: "Update", + link: "/env/update", + }, + ], + }, + ]; } function sidebar() { - return [ - { - text: 'Converters', - collapsed: false, - items: [ - { - text: 'Home', - link: '/core/converters' - }, - { - text: 'Angle', - link: '/core/converters/angle' - }, - { - text: 'Colors', - collapsed: true, - items: [ - { - text: 'RGB', - link: '/core/converters/colors/rgb' - }, - { - text: 'HEX', - link: '/core/converters/colors/hex' - }, - { - text: 'HSV', - link: '/core/converters/colors/hsv' - }, - ] - }, - { - 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' - }, - { - text: 'Temperatures', - link: '/core/converters/temperatures' - }, - { - text: 'Time', - link: '/core/converters/time' - }, - { - text: 'Volumes', - link: '/core/converters/volumes' - }, - ] - }, - { - text: 'Crypt', - collapsed: false, - items: [ - { - text: 'Crypt', - link: '/core/crypt' - } - ] - }, - { - text: 'Guid', - collapsed: false, - items: [ - { - text: 'GuidGen', - link: '/core/guid' - }, - { - text: 'GuidOptions', - link: '/core/guid-options' - } - ] - }, - { - text: 'Internet', - collapsed: false, - items: [ - { - text: 'Internet', - link: '/core/internet' - } - ] - }, - { - text: 'Maths', - collapsed: false, - items: [ - { - text: 'Home', - link: '/core/maths' - }, - { - text: 'Algebra', - link: '/core/maths/algebra' - }, - { - text: 'Geometry', - collapsed: true, - link: '/core/maths/geometry', - items: [ - { - text: 'Circle', - link: '/core/maths/geometry/circle' - }, - { - text: 'Cone', - link: '/core/maths/geometry/cone' - }, - { - text: 'Cube', - link: '/core/maths/geometry/cube' - }, - { - text: 'Cylinder', - link: '/core/maths/geometry/cylinder' - }, - { - text: 'Diamond', - link: '/core/maths/geometry/diamond' - }, - { - text: 'Hexagon', - link: '/core/maths/geometry/hexagon' - }, - { - text: 'Pyramid', - link: '/core/maths/geometry/pyramid' - }, - { - text: 'Rectangle', - link: '/core/maths/geometry/rectangle' - }, - { - text: 'Sphere', - link: '/core/maths/geometry/sphere' - }, - { - text: 'Triangle', - link: '/core/maths/geometry/triangle' - }, - ] - }, - { - text: 'Percentages', - link: '/core/maths/percentages' - }, - { - text: 'Proba', - link: '/core/maths/proba' - }, - { - text: 'Stats', - link: '/core/maths/stats' - }, - { - text: 'Trigonometry', - link: '/core/maths/trigonometry' - } - ] - }, - { - text: 'Password', - collapsed: false, - items: [ - { - text: 'Password', - link: '/core/password' - } - ] - }, - ]; + return [ + { + text: "Converters", + collapsed: false, + items: [ + { + text: "Home", + link: "/core/converters", + }, + { + text: "Angle", + link: "/core/converters/angle", + }, + { + text: "Colors", + collapsed: true, + items: [ + { + text: "RGB", + link: "/core/converters/colors/rgb", + }, + { + text: "HEX", + link: "/core/converters/colors/hex", + }, + { + text: "HSV", + link: "/core/converters/colors/hsv", + }, + ], + }, + { + 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", + }, + { + text: "Temperatures", + link: "/core/converters/temperatures", + }, + { + text: "Time", + link: "/core/converters/time", + }, + { + text: "Volumes", + link: "/core/converters/volumes", + }, + ], + }, + { + text: "Crypt", + collapsed: false, + items: [ + { + text: "Crypt", + link: "/core/crypt", + }, + ], + }, + { + text: "Guid", + collapsed: false, + items: [ + { + text: "GuidGen", + link: "/core/guid", + }, + { + text: "GuidOptions", + link: "/core/guid-options", + }, + ], + }, + { + text: "Internet", + collapsed: false, + items: [ + { + text: "Internet", + link: "/core/internet", + }, + ], + }, + { + text: "Maths", + collapsed: false, + items: [ + { + text: "Home", + link: "/core/maths", + }, + { + text: "Algebra", + link: "/core/maths/algebra", + }, + { + text: "Geometry", + collapsed: true, + link: "/core/maths/geometry", + items: [ + { + text: "Circle", + link: "/core/maths/geometry/circle", + }, + { + text: "Cone", + link: "/core/maths/geometry/cone", + }, + { + text: "Cube", + link: "/core/maths/geometry/cube", + }, + { + text: "Cylinder", + link: "/core/maths/geometry/cylinder", + }, + { + text: "Diamond", + link: "/core/maths/geometry/diamond", + }, + { + text: "Hexagon", + link: "/core/maths/geometry/hexagon", + }, + { + text: "Pyramid", + link: "/core/maths/geometry/pyramid", + }, + { + text: "Rectangle", + link: "/core/maths/geometry/rectangle", + }, + { + text: "Sphere", + link: "/core/maths/geometry/sphere", + }, + { + text: "Triangle", + link: "/core/maths/geometry/triangle", + }, + ], + }, + { + text: "Percentages", + link: "/core/maths/percentages", + }, + { + text: "Proba", + link: "/core/maths/proba", + }, + { + text: "Stats", + link: "/core/maths/stats", + }, + { + text: "Trigonometry", + link: "/core/maths/trigonometry", + }, + ], + }, + { + text: "Password", + collapsed: false, + items: [ + { + text: "Password", + link: "/core/password", + }, + ], + }, + ]; } function uiHelpersSidebar() { - return [ - { - text: 'UiHelpers', - collapsed: false, - items: [ - { - text: 'Home', - link: '/ui-helpers' - }, - { - text: 'Screen', - link: '/ui-helpers/screen' - }, - { - text: 'WinForms', - link: '/ui-helpers/winforms' - }, - { - text: 'WPF', - link: '/ui-helpers/wpf' - } - ] - }, - ]; -} \ No newline at end of file + return [ + { + text: "UiHelpers", + collapsed: false, + items: [ + { + text: "Home", + link: "/ui-helpers", + }, + { + text: "Screen", + link: "/ui-helpers/screen", + }, + { + text: "WinForms", + link: "/ui-helpers/winforms", + }, + { + text: "WPF", + link: "/ui-helpers/wpf", + }, + ], + }, + ]; +} diff --git a/Documentation/package.json b/Documentation/package.json index 4458f8f..41acb37 100644 --- a/Documentation/package.json +++ b/Documentation/package.json @@ -15,7 +15,7 @@ "keywords": [ "docs" ], - "author": "Léo Corporation + contributors", + "author": "Devyus + contributors", "license": "MIT", "bugs": { "url": "https://github.com/Leo-Corporation/PeyrSharp/issues" @@ -25,4 +25,4 @@ "vitepress": "^1.0.0-alpha.19", "vue": "^3.2.40" } -} \ No newline at end of file +} diff --git a/PeyrSharp.Core/Converters/Angle.cs b/PeyrSharp.Core/Converters/Angle.cs index b9bd04a..e599a1e 100644 --- a/PeyrSharp.Core/Converters/Angle.cs +++ b/PeyrSharp.Core/Converters/Angle.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Distances.cs b/PeyrSharp.Core/Converters/Distances.cs index 422e422..421e8f4 100644 --- a/PeyrSharp.Core/Converters/Distances.cs +++ b/PeyrSharp.Core/Converters/Distances.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Energies.cs b/PeyrSharp.Core/Converters/Energies.cs index 50c5a54..24c89f4 100644 --- a/PeyrSharp.Core/Converters/Energies.cs +++ b/PeyrSharp.Core/Converters/Energies.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -22,12 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - namespace PeyrSharp.Core.Converters { /// diff --git a/PeyrSharp.Core/Converters/HEX.cs b/PeyrSharp.Core/Converters/HEX.cs index 9428fac..ada2a22 100644 --- a/PeyrSharp.Core/Converters/HEX.cs +++ b/PeyrSharp.Core/Converters/HEX.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/HSV.cs b/PeyrSharp.Core/Converters/HSV.cs index f4ac53c..cacfddf 100644 --- a/PeyrSharp.Core/Converters/HSV.cs +++ b/PeyrSharp.Core/Converters/HSV.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Masses.cs b/PeyrSharp.Core/Converters/Masses.cs index 1b862f7..835754b 100644 --- a/PeyrSharp.Core/Converters/Masses.cs +++ b/PeyrSharp.Core/Converters/Masses.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/RGB.cs b/PeyrSharp.Core/Converters/RGB.cs index b1d158a..552b2a9 100644 --- a/PeyrSharp.Core/Converters/RGB.cs +++ b/PeyrSharp.Core/Converters/RGB.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Speeds.cs b/PeyrSharp.Core/Converters/Speeds.cs index fa995ac..c519f05 100644 --- a/PeyrSharp.Core/Converters/Speeds.cs +++ b/PeyrSharp.Core/Converters/Speeds.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -22,12 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - namespace PeyrSharp.Core.Converters { /// diff --git a/PeyrSharp.Core/Converters/Storage.cs b/PeyrSharp.Core/Converters/Storage.cs index 2e11806..3a3e88b 100644 --- a/PeyrSharp.Core/Converters/Storage.cs +++ b/PeyrSharp.Core/Converters/Storage.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Temperatures.cs b/PeyrSharp.Core/Converters/Temperatures.cs index 33f30da..3026ac6 100644 --- a/PeyrSharp.Core/Converters/Temperatures.cs +++ b/PeyrSharp.Core/Converters/Temperatures.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Time.cs b/PeyrSharp.Core/Converters/Time.cs index 002d22b..9ad42f0 100644 --- a/PeyrSharp.Core/Converters/Time.cs +++ b/PeyrSharp.Core/Converters/Time.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Converters/Volumes.cs b/PeyrSharp.Core/Converters/Volumes.cs index 749c6ed..ce8a7af 100644 --- a/PeyrSharp.Core/Converters/Volumes.cs +++ b/PeyrSharp.Core/Converters/Volumes.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Crypt.cs b/PeyrSharp.Core/Crypt.cs index 4397f5b..d8b78b5 100644 --- a/PeyrSharp.Core/Crypt.cs +++ b/PeyrSharp.Core/Crypt.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Guid.cs b/PeyrSharp.Core/Guid.cs index cac4e2f..26ca451 100644 --- a/PeyrSharp.Core/Guid.cs +++ b/PeyrSharp.Core/Guid.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Internet.cs b/PeyrSharp.Core/Internet.cs index c633d79..5c73de3 100644 --- a/PeyrSharp.Core/Internet.cs +++ b/PeyrSharp.Core/Internet.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Algebra.cs b/PeyrSharp.Core/Maths/Algebra.cs index edae02a..a6f4792 100644 --- a/PeyrSharp.Core/Maths/Algebra.cs +++ b/PeyrSharp.Core/Maths/Algebra.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Circle.cs b/PeyrSharp.Core/Maths/Geometry/Circle.cs index e61125e..dadf5bd 100644 --- a/PeyrSharp.Core/Maths/Geometry/Circle.cs +++ b/PeyrSharp.Core/Maths/Geometry/Circle.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Cone.cs b/PeyrSharp.Core/Maths/Geometry/Cone.cs index 23626f3..5018a06 100644 --- a/PeyrSharp.Core/Maths/Geometry/Cone.cs +++ b/PeyrSharp.Core/Maths/Geometry/Cone.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Cube.cs b/PeyrSharp.Core/Maths/Geometry/Cube.cs index 12b4277..cd125ea 100644 --- a/PeyrSharp.Core/Maths/Geometry/Cube.cs +++ b/PeyrSharp.Core/Maths/Geometry/Cube.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Cylinder.cs b/PeyrSharp.Core/Maths/Geometry/Cylinder.cs index 6fb5731..48ec328 100644 --- a/PeyrSharp.Core/Maths/Geometry/Cylinder.cs +++ b/PeyrSharp.Core/Maths/Geometry/Cylinder.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Diamond.cs b/PeyrSharp.Core/Maths/Geometry/Diamond.cs index 7bbad16..9cd7e82 100644 --- a/PeyrSharp.Core/Maths/Geometry/Diamond.cs +++ b/PeyrSharp.Core/Maths/Geometry/Diamond.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Hexagon.cs b/PeyrSharp.Core/Maths/Geometry/Hexagon.cs index eb75d09..6b49937 100644 --- a/PeyrSharp.Core/Maths/Geometry/Hexagon.cs +++ b/PeyrSharp.Core/Maths/Geometry/Hexagon.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Pyramid.cs b/PeyrSharp.Core/Maths/Geometry/Pyramid.cs index 38500a2..523d086 100644 --- a/PeyrSharp.Core/Maths/Geometry/Pyramid.cs +++ b/PeyrSharp.Core/Maths/Geometry/Pyramid.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Rectangle.cs b/PeyrSharp.Core/Maths/Geometry/Rectangle.cs index 238398f..a24c18f 100644 --- a/PeyrSharp.Core/Maths/Geometry/Rectangle.cs +++ b/PeyrSharp.Core/Maths/Geometry/Rectangle.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Sphere.cs b/PeyrSharp.Core/Maths/Geometry/Sphere.cs index 55a0b33..180b885 100644 --- a/PeyrSharp.Core/Maths/Geometry/Sphere.cs +++ b/PeyrSharp.Core/Maths/Geometry/Sphere.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Geometry/Triangle.cs b/PeyrSharp.Core/Maths/Geometry/Triangle.cs index caab3a7..9183c65 100644 --- a/PeyrSharp.Core/Maths/Geometry/Triangle.cs +++ b/PeyrSharp.Core/Maths/Geometry/Triangle.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Percentages.cs b/PeyrSharp.Core/Maths/Percentages.cs index 7dc9abb..93ef463 100644 --- a/PeyrSharp.Core/Maths/Percentages.cs +++ b/PeyrSharp.Core/Maths/Percentages.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Proba.cs b/PeyrSharp.Core/Maths/Proba.cs index 2a247fd..7abcee7 100644 --- a/PeyrSharp.Core/Maths/Proba.cs +++ b/PeyrSharp.Core/Maths/Proba.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Maths/Stats.cs b/PeyrSharp.Core/Maths/Stats.cs index ecf6dbe..decd566 100644 --- a/PeyrSharp.Core/Maths/Stats.cs +++ b/PeyrSharp.Core/Maths/Stats.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -25,8 +25,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE using System; using System.Collections.Generic; using System.Linq; -using System.Text; -using System.Threading.Tasks; namespace PeyrSharp.Core.Maths { diff --git a/PeyrSharp.Core/Maths/Trigonometry.cs b/PeyrSharp.Core/Maths/Trigonometry.cs index 2354fe6..a004c6d 100644 --- a/PeyrSharp.Core/Maths/Trigonometry.cs +++ b/PeyrSharp.Core/Maths/Trigonometry.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/Password.cs b/PeyrSharp.Core/Password.cs index a5247b7..98811a3 100644 --- a/PeyrSharp.Core/Password.cs +++ b/PeyrSharp.Core/Password.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Core/PeyrSharp.Core.csproj b/PeyrSharp.Core/PeyrSharp.Core.csproj index 49e65cb..9c8b3a8 100644 --- a/PeyrSharp.Core/PeyrSharp.Core.csproj +++ b/PeyrSharp.Core/PeyrSharp.Core.csproj @@ -5,7 +5,7 @@ True PeyrSharp.Core 1.5.0.2304 - Léo Corporation + Devyus Core methods and features of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.Enums/ControlAlignment.cs b/PeyrSharp.Enums/ControlAlignment.cs index ca4ac33..6ce11bc 100644 --- a/PeyrSharp.Enums/ControlAlignment.cs +++ b/PeyrSharp.Enums/ControlAlignment.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/LogLevel.cs b/PeyrSharp.Enums/LogLevel.cs index 7d3f728..0d96b66 100644 --- a/PeyrSharp.Enums/LogLevel.cs +++ b/PeyrSharp.Enums/LogLevel.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/OperatingSystems.cs b/PeyrSharp.Enums/OperatingSystems.cs index 59f2550..d1d2185 100644 --- a/PeyrSharp.Enums/OperatingSystems.cs +++ b/PeyrSharp.Enums/OperatingSystems.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/PasswordPresets.cs b/PeyrSharp.Enums/PasswordPresets.cs index b5e9bfa..8850749 100644 --- a/PeyrSharp.Enums/PasswordPresets.cs +++ b/PeyrSharp.Enums/PasswordPresets.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/PasswordStrength.cs b/PeyrSharp.Enums/PasswordStrength.cs index 63f6c29..678a333 100644 --- a/PeyrSharp.Enums/PasswordStrength.cs +++ b/PeyrSharp.Enums/PasswordStrength.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/PeyrSharp.Enums.csproj b/PeyrSharp.Enums/PeyrSharp.Enums.csproj index 043468f..02eb772 100644 --- a/PeyrSharp.Enums/PeyrSharp.Enums.csproj +++ b/PeyrSharp.Enums/PeyrSharp.Enums.csproj @@ -5,7 +5,7 @@ disable enable PeyrSharp.Enums - Léo Corporation + Devyus Enumerations of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.Enums/StatusCodes.cs b/PeyrSharp.Enums/StatusCodes.cs index 96876b1..8d02386 100644 --- a/PeyrSharp.Enums/StatusCodes.cs +++ b/PeyrSharp.Enums/StatusCodes.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/StorageUnits.cs b/PeyrSharp.Enums/StorageUnits.cs index 9ef2a37..4fe4f2a 100644 --- a/PeyrSharp.Enums/StorageUnits.cs +++ b/PeyrSharp.Enums/StorageUnits.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/SystemThemes.cs b/PeyrSharp.Enums/SystemThemes.cs index 4a7e4e1..4d29566 100644 --- a/PeyrSharp.Enums/SystemThemes.cs +++ b/PeyrSharp.Enums/SystemThemes.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/TimeUnits.cs b/PeyrSharp.Enums/TimeUnits.cs index 344f64b..1a825d0 100644 --- a/PeyrSharp.Enums/TimeUnits.cs +++ b/PeyrSharp.Enums/TimeUnits.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/TriangleSides.cs b/PeyrSharp.Enums/TriangleSides.cs index 241243f..cde87d5 100644 --- a/PeyrSharp.Enums/TriangleSides.cs +++ b/PeyrSharp.Enums/TriangleSides.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Enums/WindowsVersion.cs b/PeyrSharp.Enums/WindowsVersion.cs index c074051..fb21134 100644 --- a/PeyrSharp.Enums/WindowsVersion.cs +++ b/PeyrSharp.Enums/WindowsVersion.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Env/FileSys.cs b/PeyrSharp.Env/FileSys.cs index cb8c6d4..7b1c826 100644 --- a/PeyrSharp.Env/FileSys.cs +++ b/PeyrSharp.Env/FileSys.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Env/Logger.cs b/PeyrSharp.Env/Logger.cs index 5b5a781..0f87e08 100644 --- a/PeyrSharp.Env/Logger.cs +++ b/PeyrSharp.Env/Logger.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Env/PeyrSharp.Env.csproj b/PeyrSharp.Env/PeyrSharp.Env.csproj index 3c52383..668ff56 100644 --- a/PeyrSharp.Env/PeyrSharp.Env.csproj +++ b/PeyrSharp.Env/PeyrSharp.Env.csproj @@ -5,7 +5,7 @@ True PeyrSharp.Env 1.5.0.2304 - Léo Corporation + Devyus Environment-related methods of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.Env/Sys.cs b/PeyrSharp.Env/Sys.cs index 9e14495..7c3988d 100644 --- a/PeyrSharp.Env/Sys.cs +++ b/PeyrSharp.Env/Sys.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Env/Update.cs b/PeyrSharp.Env/Update.cs index 9524fe7..fe7e5d4 100644 --- a/PeyrSharp.Env/Update.cs +++ b/PeyrSharp.Env/Update.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Exceptions/HEXInvalidValueException.cs b/PeyrSharp.Exceptions/HEXInvalidValueException.cs index 5369486..c6b3763 100644 --- a/PeyrSharp.Exceptions/HEXInvalidValueException.cs +++ b/PeyrSharp.Exceptions/HEXInvalidValueException.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Exceptions/InvalidGuidLenghtException.cs b/PeyrSharp.Exceptions/InvalidGuidLenghtException.cs index ba6ae0f..a13a122 100644 --- a/PeyrSharp.Exceptions/InvalidGuidLenghtException.cs +++ b/PeyrSharp.Exceptions/InvalidGuidLenghtException.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj b/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj index d8a7439..f9dc861 100644 --- a/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj +++ b/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj @@ -7,7 +7,7 @@ True PeyrSharp.Exceptions 1.5.0.2304 - Léo Corporation + Devyus Exceptions of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.Exceptions/RGBInvalidValueException.cs b/PeyrSharp.Exceptions/RGBInvalidValueException.cs index e426d2a..c682967 100644 --- a/PeyrSharp.Exceptions/RGBInvalidValueException.cs +++ b/PeyrSharp.Exceptions/RGBInvalidValueException.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Extensions/ArrayExtensions.cs b/PeyrSharp.Extensions/ArrayExtensions.cs index a8ab3af..295c1f5 100644 --- a/PeyrSharp.Extensions/ArrayExtensions.cs +++ b/PeyrSharp.Extensions/ArrayExtensions.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Extensions/DoubleExtensions.cs b/PeyrSharp.Extensions/DoubleExtensions.cs index 7000e78..482a38d 100644 --- a/PeyrSharp.Extensions/DoubleExtensions.cs +++ b/PeyrSharp.Extensions/DoubleExtensions.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Extensions/IntExtensions.cs b/PeyrSharp.Extensions/IntExtensions.cs index fb5ee29..ca5525b 100644 --- a/PeyrSharp.Extensions/IntExtensions.cs +++ b/PeyrSharp.Extensions/IntExtensions.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj b/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj index 581117e..95e465e 100644 --- a/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj +++ b/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj @@ -5,7 +5,7 @@ True PeyrSharp.Extensions 1.5.0.2304 - Léo Corporation + Devyus Extensions methods of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.Extensions/StringExtensions.cs b/PeyrSharp.Extensions/StringExtensions.cs index a0f19c8..ddf5013 100644 --- a/PeyrSharp.Extensions/StringExtensions.cs +++ b/PeyrSharp.Extensions/StringExtensions.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj b/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj index 024c7ec..278db11 100644 --- a/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj +++ b/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj @@ -9,7 +9,7 @@ True PeyrSharp.UiHelpers 1.5.0.2304 - Léo Corporation + Devyus Useful helpers for Windows Forms and Windows Presentation Framework. © 2023 https://peyrsharp.leocorporation.dev/ diff --git a/PeyrSharp.UiHelpers/ScreenHelpers.cs b/PeyrSharp.UiHelpers/ScreenHelpers.cs index bb1a405..86371e5 100644 --- a/PeyrSharp.UiHelpers/ScreenHelpers.cs +++ b/PeyrSharp.UiHelpers/ScreenHelpers.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.UiHelpers/WinFormsHelpers.cs b/PeyrSharp.UiHelpers/WinFormsHelpers.cs index 67b8932..1bbbcf0 100644 --- a/PeyrSharp.UiHelpers/WinFormsHelpers.cs +++ b/PeyrSharp.UiHelpers/WinFormsHelpers.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp.UiHelpers/WpfHelpers.cs b/PeyrSharp.UiHelpers/WpfHelpers.cs index aa755c9..426622b 100644 --- a/PeyrSharp.UiHelpers/WpfHelpers.cs +++ b/PeyrSharp.UiHelpers/WpfHelpers.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp/PeyrSharp.cs b/PeyrSharp/PeyrSharp.cs index daac84b..c135f4e 100644 --- a/PeyrSharp/PeyrSharp.cs +++ b/PeyrSharp/PeyrSharp.cs @@ -1,7 +1,7 @@ /* MIT License -Copyright (c) Léo Corporation +Copyright (c) Devyus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/PeyrSharp/PeyrSharp.csproj b/PeyrSharp/PeyrSharp.csproj index ee71e8b..08ac79a 100644 --- a/PeyrSharp/PeyrSharp.csproj +++ b/PeyrSharp/PeyrSharp.csproj @@ -5,7 +5,7 @@ True PeyrSharp 1.5.0.2304 - Léo Corporation + Devyus © 2023 A C# library designed to make developers' job easier. https://peyrsharp.leocorporation.dev/ diff --git a/docs/404.html b/docs/404.html index bc6c37c..1385b68 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,20 +1,481 @@ - - + + 404 | PeyrSharp - - + + - - - + + + -
Skip to content

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+ +
+ +
+

404

+

PAGE NOT FOUND

+
+
+ But if you don't change your direction, and if you keep + looking, you may end up where you are heading. +
+ +
+ +
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core.html b/docs/core.html index 4eb7ada..b5966a6 100644 --- a/docs/core.html +++ b/docs/core.html @@ -1,23 +1,1698 @@ - - + + Core | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Core

This page is about the PeyrSharp.Core module.

Compatibility

The PeyrSharp.Core module is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Namespaces

The Core namespace contains other namespaces:

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Core + +

+

This page is about the PeyrSharp.Core module.

+

+ Compatibility + +

+

+ The PeyrSharp.Core module is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Namespaces + +

+

+ The Core namespace contains other + namespaces: +

+ +

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters.html b/docs/core/converters.html index 0a2f34a..73d154a 100644 --- a/docs/core/converters.html +++ b/docs/core/converters.html @@ -1,23 +1,1717 @@ - - + + Converters | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Converters

This page is about the Converters namespace available in PeyrSharp.Core. You can find here all of its classes.

Compatibility

The Converters namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Converters + +

+

+ This page is about the + Converters namespace available in + PeyrSharp.Core. You can find here all of its classes. +

+

+ Compatibility + +

+

+ The Converters namespace is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/angle.html b/docs/core/converters/angle.html index 70c28e2..7c59590 100644 --- a/docs/core/converters/angle.html +++ b/docs/core/converters/angle.html @@ -1,31 +1,1820 @@ - - + + Angle | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Angle

This page is about the Angle class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Angle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

DegreesToRadians(degrees)

Definition

Converts degrees to radians. Returns a double value.

Arguments

TypeNameMeaning
doubledegreesNumber of degrees to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Angle + +

+

+ This page is about the Angle class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Angle class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ DegreesToRadians(degrees) + +

+

+ Definition + +

+

+ Converts degrees to radians. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubledegreesNumber of degrees to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double radians = Angle.DegreesToRadians(90);
 // radians = 1.5707963271535559
-

RadiansToDegrees(radians)

Definition

Converts radians to degrees. Returns a double value.

Arguments

TypeNameMeaning
doubleradiansNumber of radians to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ RadiansToDegrees(radians) + +

+

+ Definition + +

+

+ Converts radians to degrees. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleradiansNumber of radians to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double deg = Angle.RadiansToDegrees(1.2);
 // deg = 68.7549354
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/colors/hex.html b/docs/core/converters/colors/hex.html index fd33a15..26fe560 100644 --- a/docs/core/converters/colors/hex.html +++ b/docs/core/converters/colors/hex.html @@ -1,33 +1,1916 @@ - - + + HEX | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

HEX

This page is about the HEX class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.

Compatibility

The HEX class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

HEX(hex)

Initializes a hexadecimal class from a hexadecimal value.

Arguments

TypeNameMeaning
stringhexThe hexadecimal value (with or without #).

WARNING

If you specify a non-hexadecimal value, a HEXInvalidValueException will be thrown.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ HEX + +

+

+ This page is about the HEX class + available in + PeyrSharp.Core.Converters. You can find here all of its methods and + properties. +

+

+ Compatibility + +

+

+ The HEX class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ HEX(hex) + +

+

+ Initializes a hexadecimal class from a hexadecimal + value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringhex + The hexadecimal value (with or without + #). +
+
+

WARNING

+

+ If you specify a non-hexadecimal value, a + HEXInvalidValueException + will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 HEX hex = new("#FF0A17");
-

Methods

ToRgb()

Definition

Converts the HEX color to RGB. Returns a RGB class.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ Methods + +

+

+ ToRgb() + +

+

+ Definition + +

+

+ Converts the HEX color to + RGB. Returns a + RGB + class. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 RGB rgb = new HEX("#FFFFFF").ToRgb();
-

ToHsv()

Definition

Converts the HEX color to HSV. Returns a HSV class.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToHsv() + +

+

+ Definition + +

+

+ Converts the HEX color to + HSV. Returns a + HSV + class. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 HSV hsv = new HEX("#E1077B").ToHsv();
-

Properties

Value

Definition

c#
public string Value { get; init; }
-

The Value property contains the hexadecimal value of the HEX color. You can only get this property.

Released under the MIT License.

- - +
+
+

+ Properties + +

+

+ Value + +

+

+ Definition + +

+
+ c# +
public string Value { get; init; }
+
+
+

+ The Value property contains the + hexadecimal value of the HEX color. You can only + get this property. +

+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/colors/hsv.html b/docs/core/converters/colors/hsv.html index cebce38..dc8d04e 100644 --- a/docs/core/converters/colors/hsv.html +++ b/docs/core/converters/colors/hsv.html @@ -1,29 +1,1863 @@ - - + + HSV | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

HSV

This page is about the HSV class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.

Compatibility

The HSV class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

HSV(hue, saturation, value)

Definition

Initializes a HSV color from its hue, saturation, and value.

Arguments

TypeNameMeaning
inthueThe Hue of the color.
intsaturationThe saturation percentage.
intvalueThe value/brightness percentage.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ HSV + +

+

+ This page is about the HSV class + available in + PeyrSharp.Core.Converters. You can find here all of its methods and + properties. +

+

+ Compatibility + +

+

+ The HSV class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ HSV(hue, saturation, value) + +

+

+ Definition + +

+

+ Initializes a HSV color from its hue, + saturation, and value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
inthueThe Hue of the color.
intsaturationThe saturation percentage.
intvalueThe value/brightness percentage.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 HSV hsv = new(50, 75, 100);
-

Properties

Hue

Definition

c#
public int Hue { get; init; }
-

The Hue property contains the hue of the HSV color. You can only get this property.

Saturation

Definition

c#
public int Saturation { get; init; }
-

The Value property contains the saturation percentage of the HSV color. You can only get this property.

Value

Definition

c#
public int Value { get; init; }
-

The Value property contains the value/brightness percentage of the HSV color. You can only get this property.

Released under the MIT License.

- - +
+
+

+ Properties + +

+

+ Hue + +

+

+ Definition + +

+
+ c# +
public int Hue { get; init; }
+
+
+

+ The Hue property contains the hue of the + HSV color. You can only get this + property. +

+

+ Saturation + +

+

+ Definition + +

+
+ c# +
public int Saturation { get; init; }
+
+
+

+ The Value property contains the + saturation percentage of the HSV color. You can only + get this property. +

+

+ Value + +

+

+ Definition + +

+
+ c# +
public int Value { get; init; }
+
+
+

+ The Value property contains the + value/brightness percentage of the HSV color. You can + only get this property. +

+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/colors/rgb.html b/docs/core/converters/colors/rgb.html index c0f7e33..f6d9792 100644 --- a/docs/core/converters/colors/rgb.html +++ b/docs/core/converters/colors/rgb.html @@ -1,37 +1,2011 @@ - - + + RGB | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

RGB

This page is about the RGB class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.

Compatibility

The RGB class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

RGB(color)

Definition

Initializes a RGB class from a System.Drawing.Color. Returns a RGB class.

Arguments

TypeNameMeaning
ColorcolorThe RGB color.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ RGB + +

+

+ This page is about the RGB class + available in + PeyrSharp.Core.Converters. You can find here all of its methods and + properties. +

+

+ Compatibility + +

+

+ The RGB class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ RGB(color) + +

+

+ Definition + +

+

+ Initializes a RGB class from a + System.Drawing.Color. Returns a RGB class. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
ColorcolorThe RGB color.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 using System.Drawing;
 
 RGB rgb = new(Color.FromArgb(255, 150, 120));
-

RGB(r, g, b)

Definition

Initializes a RGB class from its r, g and b values. Returns a RGB class.

Arguments

TypeNameMeaning
intrRed.
intgGreen.
intbBlue.

WARNING

If you specify a value that is not between 0 and 255, a RGBInvalidValueException will be thrown.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ RGB(r, g, b) + +

+

+ Definition + +

+

+ Initializes a RGB class from its r, + g and b values. Returns a + RGB class. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
intrRed.
intgGreen.
intbBlue.
+
+

WARNING

+

+ If you specify a value that is not between 0 and + 255, a + RGBInvalidValueException + will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 RGB rgb = new(255, 150, 120);
-

Methods

ToHex()

Definition

Converts the RGB color to hexadecimal (HEX). Returns a HEX class.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ Methods + +

+

+ ToHex() + +

+

+ Definition + +

+

+ Converts the RGB color to hexadecimal (HEX). Returns a + HEX + class. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 HEX hex = new RGB(255, 0, 0).ToHex();
-

ToHsv()

Definition

Converts the RGB color to HSV. Returns a HSV class.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToHsv() + +

+

+ Definition + +

+

+ Converts the RGB color to + HSV. Returns a + HSV + class. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 HSV hsv = new RGB(255, 0, 0).ToHsv();
-

Properties

Color

Definition

c#
public Color Color { get; init; }
-

The Color property contains the RGB color as a System.Drawing.Color. You can only get this property.

Released under the MIT License.

- - +
+
+

+ Properties + +

+

+ Color + +

+

+ Definition + +

+
+ c# +
public Color Color { get; init; }
+
+
+

+ The Color property contains the RGB color + as a + System.Drawing.Color. You can only get this property. +

+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/distances.html b/docs/core/converters/distances.html index 535487f..efc56f8 100644 --- a/docs/core/converters/distances.html +++ b/docs/core/converters/distances.html @@ -1,39 +1,1956 @@ - - + + Distances | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Distances

This page is about the Distances class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Distances class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

MilesToKm(miles)

Definition

Converts miles to kilometers. Returns a double value.

Arguments

TypeNameMeaning
doublemilesNumber of mile(s) to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Distances + +

+

+ This page is about the Distances class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Distances class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ MilesToKm(miles) + +

+

+ Definition + +

+

+ Converts miles to kilometers. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublemilesNumber of mile(s) to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double km = Distances.MilesToKm(10);
 // km = 16.09344
-

KmToMiles(km)

Definition

Converts kilometers to miles. Returns a double value.

Arguments

TypeNameMeaning
doublekilometersNumber of kilometers(s) to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KmToMiles(km) + +

+

+ Definition + +

+

+ Converts kilometers to miles. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublekilometersNumber of kilometers(s) to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double miles = Distances.KmToMiles(5);
 // miles = 3.1068559611866697
-

FeetToMeters(feet)

Definition

Converts feet to meters. Returns a double value.

Arguments

TypeNameMeaning
doublefeetNumber of feet to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ FeetToMeters(feet) + +

+

+ Definition + +

+

+ Converts feet to meters. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublefeetNumber of feet to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double meters = Distances.FeetToMeters(12);
 // meters = 3.657599994440448
-

MetersToFeet(meters)

Definition

Converts meters to feet. Returns a double value.

Arguments

TypeNameMeaning
doublemetersNumber of meters to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ MetersToFeet(meters) + +

+

+ Definition + +

+

+ Converts meters to feet. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublemetersNumber of meters to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double feet = Distances.MetersToFeet(3.657599994440448);
 // feet = 12
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/energies.html b/docs/core/converters/energies.html index ac1d689..ebf58ba 100644 --- a/docs/core/converters/energies.html +++ b/docs/core/converters/energies.html @@ -1,31 +1,1839 @@ - - + + Energies | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Energies

This page is about the Energies class available in PeyrSharp.Core.Converters. 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/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

CaloriesToJoules(calories)

Definition

Converts calories to joules.

Arguments

TypeNameMeaning
doublecaloriesThe amount of energy in calories to be converted.

Returns

The equivalent amount of energy in joules.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Energies + +

+

+ This page is about the Energies class + available in + PeyrSharp.Core.Converters. 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/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ CaloriesToJoules(calories) + +

+

+ Definition + +

+

Converts calories to joules.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublecalories + 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

TypeNameMeaning
doublejoulesThe amount of energy in joules.

Returns

The equivalent amount of energy in calories.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ JoulesToCalories(joules) + +

+

+ Definition + +

+

Converts joules to calories.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublejoulesThe 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);
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/masses.html b/docs/core/converters/masses.html index 1a06f05..1328998 100644 --- a/docs/core/converters/masses.html +++ b/docs/core/converters/masses.html @@ -1,31 +1,1822 @@ - - + + Masses | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Masses

This page is about the Masses class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Masses class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

PoundsToKilograms(pounds)

Definition

Converts pounds to kilograms. Returns a double value.

Arguments

TypeNameMeaning
doublepoundsNumber of pounds to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Masses + +

+

+ This page is about the Masses class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Masses class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ PoundsToKilograms(pounds) + +

+

+ Definition + +

+

+ Converts pounds to kilograms. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublepoundsNumber of pounds to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double kg = Masses.PoundsToKilograms(10);
 // kg = 4.535923703803784
-

KilogramsToPounds(kilograms)

Definition

Converts kilograms to pounds. Returns a double value.

Arguments

TypeNameMeaning
doublekilogramsNumber of kilograms to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KilogramsToPounds(kilograms) + +

+

+ Definition + +

+

+ Converts kilograms to pounds. Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublekilogramsNumber of kilograms to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double pounds = Masses.KilogramsToPounds(25);
 // pounds = 55.115565499999995
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/speeds.html b/docs/core/converters/speeds.html index 88e4c67..dfea9d0 100644 --- a/docs/core/converters/speeds.html +++ b/docs/core/converters/speeds.html @@ -1,63 +1,2305 @@ - - + + Speeds | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Speeds

This page is about the Speeds class available in PeyrSharp.Core.Converters. 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/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

KnotsToKilometersPerHour(knots)

Definition

Converts knots to kilometers per hour.

Arguments

TypeNameMeaning
doubleknotsThe speed in knots.

Returns

The equivalent speed in kilometers per hour.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Speeds + +

+

+ This page is about the Speeds class + available in + PeyrSharp.Core.Converters. 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/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ KnotsToKilometersPerHour(knots) + +

+

+ Definition + +

+

Converts knots to kilometers per hour.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleknotsThe 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

TypeNameDescription
doublekilometersPerHourThe speed in kilometers per hour.

Returns

The equivalent speed in knots.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KilometersPerHourToKnots(kilometersPerHour) + +

+

+ Definition + +

+

Converts kilometers per hour to knots.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doublekilometersPerHourThe 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

TypeNameDescription
doubleknotsThe speed in knots.

Returns

The equivalent speed in miles per hour.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KnotsToMilesPerHour(knots) + +

+

+ Definition + +

+

Converts knots to miles per hour.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doubleknotsThe 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

TypeNameDescription
doublemilesPerHourThe speed in miles per hour.

Returns

The equivalent speed in knots.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ MilesPerHourToKnots(milesPerHour) + +

+

+ Definition + +

+

Converts miles per hour to knots.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doublemilesPerHourThe 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

TypeNameDescription
doublekilometersPerHourThe speed in kilometers per hour.

Returns

The equivalent speed in meters per second.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KilometersPerHourToMetersPerSecond(kilometersPerHour) + +

+

+ Definition + +

+

+ Converts kilometers per hour to meters per second. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doublekilometersPerHourThe 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

TypeNameMeaning
doublemetersPerSecondThe speed in meters per second.

Returns

The equivalent speed in kilometers per hour.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ MetersPerSecondToKilometersPerHour(metersPerSecond) + +

+

+ Definition + +

+

+ Converts meters per second to kilometers per hour. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublemetersPerSecondThe 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

TypeNameDescription
doublemilesPerHourThe speed in miles per hour.

Returns

The equivalent speed in kilometers per hour.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ MilesPerHourToKilometersPerHour(milesPerHour) + +

+

+ Definition + +

+

Converts miles per hour to kilometers per hour.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doublemilesPerHourThe 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

TypeNameDescription
doublekilometersPerHourThe speed in kilometers per hour.

Returns

The equivalent speed in miles per hour.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ KilometersPerHourToMilesPerHour(kilometersPerHour) + +

+

+ Definition + +

+

Converts kilometers per hour to miles per hour.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
doublekilometersPerHourThe 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");
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/storage.html b/docs/core/converters/storage.html index 00122f6..c6f3b23 100644 --- a/docs/core/converters/storage.html +++ b/docs/core/converters/storage.html @@ -1,47 +1,2220 @@ - - + + Storage | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Storage

This page is about the Storage class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Storage class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

ToByte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to byte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Storage + +

+

+ This page is about the Storage class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Storage class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ ToByte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to byte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double byte = Storage.ToByte(1, StorageUnits.Kilobyte);
 // byte = 1000
-

ToKilobyte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to kilobyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: byte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToKilobyte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to kilobyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: byte, gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double kilobyte = Storage.ToKilobyte(2000, StorageUnits.Byte);
 // kilobyte = 2
-

ToMegabyte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to megabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToMegabyte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to megabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double megabyte = Storage.ToMegabyte(1500, StorageUnits.Kilobyte);
 // megabyte = 1.5
-

ToGigabyte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to gigabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, megabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToGigabyte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to gigabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + megabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double gigabyte = Storage.ToGigabyte(1000, StorageUnits.Megabyte);
 // gigabyte = 1
-

ToTerabyte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to terabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToTerabyte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to terabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double terabyte = Storage.ToTerabyte(1, StorageUnits.Petabyte);
 // terabyte = 1000
-

ToPetabyte(value, storageUnit)

Definition

Converts a size (kb, mb, ...) to petabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doublevalueThe value to convert.
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToPetabyte(value, storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to petabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe value to convert.
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double petabyte = Storage.ToPetabyte(1000, StorageUnits.Terabyte);
 // petabyte = 1
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/temperatures.html b/docs/core/converters/temperatures.html index c8f9076..a47ebeb 100644 --- a/docs/core/converters/temperatures.html +++ b/docs/core/converters/temperatures.html @@ -1,31 +1,1820 @@ - - + + Temperatures | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Temperatures

This page is about the Temperatures class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Temperatures class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

CelsiusToFahrenheit(celsius)

Definition

Converts Celsius (°C) to Fahrenheit (°F). Returns a double value.

Arguments

TypeNameMeaning
doublecelsiusNumber of Celsius to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Temperatures + +

+

+ This page is about the Temperatures class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Temperatures class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ CelsiusToFahrenheit(celsius) + +

+

+ Definition + +

+

+ Converts Celsius (°C) to Fahrenheit (°F). Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublecelsiusNumber of Celsius to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double f = Temperatures.CelsiusToFahrenheit(22);
 // f = 71.6
-

FahrenheitToCelsius(fahrenheit)

Definition

Converts Fahrenheit (°F) to Celsius (°C). Returns a double value.

Arguments

TypeNameMeaning
doublefahrenheitNumber of Fahrenheit to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ FahrenheitToCelsius(fahrenheit) + +

+

+ Definition + +

+

+ Converts Fahrenheit (°F) to Celsius (°C). Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublefahrenheitNumber of Fahrenheit to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double c = Temperatures.FahrenheitToCelsius(75);
 // c = 23.88888888888889
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/time.html b/docs/core/converters/time.html index 54d6893..fd37ebb 100644 --- a/docs/core/converters/time.html +++ b/docs/core/converters/time.html @@ -1,50 +1,2192 @@ - - + + Time | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Time

This page is about the Time class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Time class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

ToSeconds(d, timeUnits)

Definition

Converts a specified time unit value to seconds. For instance, you can convert days, hours or minutes to seconds. It returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doubledThe time unit to convert.
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Time + +

+

+ This page is about the Time class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Time class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ ToSeconds(d, timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to seconds. For + instance, you can convert days, hours or minutes to + seconds. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubledThe time unit to convert.
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 using PeyrSharp.Enums;
 
 double seconds = Time.ToSeconds(5, TimeUnits.Minutes);
 // seconds = 300
-

ToMinutes(d, timeUnits)

Definition

Converts a specified time unit value to minutes. For instance, you can convert days, hours or seconds to minutes. It returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doubledThe time unit to convert.
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToMinutes(d, timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to minutes. For + instance, you can convert days, hours or seconds to + minutes. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubledThe time unit to convert.
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 using PeyrSharp.Enums;
 
 double min = Time.ToMinutes(120, TimeUnits.Seconds);
 // min = 2
-

ToHours(d, timeUnits)

Definition

Converts a specified time unit value to hours. For instance, you can convert days, minutes or seconds to hours. It returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doubledThe time unit to convert.
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToHours(d, timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to hours. For + instance, you can convert days, minutes or seconds to + hours. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubledThe time unit to convert.
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 using PeyrSharp.Enums;
 
 double hours = Time.ToHours(1, TimeUnits.Days);
 // hours = 24
-

ToDays(d, timeUnits)

Definition

Converts a specified time unit value to days. For instance, you can convert hours, minutes or seconds to days. It returns a double value.

INFO

This method can also be used in PeyrSharp.Extensions.

Arguments

TypeNameMeaning
doubledThe time unit to convert.
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToDays(d, timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to days. For + instance, you can convert hours, minutes or seconds to + days. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Extensions. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubledThe time unit to convert.
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 using PeyrSharp.Enums;
 
 double days = Time.ToDays(72, TimeUnits.Hours);
 // days = 3
-

UnixTimeToDateTime(unixTime)

Available in version 1.1 and higher.

Definition

Converts Unix Time to DateTime. It returns a DateTime value.

Arguments

TypeNameMeaning
intunixTimeThe Unix Time to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ UnixTimeToDateTime(unixTime) + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+

+ Converts Unix Time to + DateTime. It returns a DateTime value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
intunixTimeThe Unix Time to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 var date = Time.UnixTimeToDateTime(1670144268); // 12/04/2022 08:57:48
-

DateTimeToUnixTime(dateTime)

Available in version 1.1 and higher.

Definition

Converts DateTime to Unix Time. It returns an int value.

Arguments

TypeNameMeaning
DateTimedateTimeThe converted DateTime in Unix Time.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ DateTimeToUnixTime(dateTime) + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+

+ Converts + DateTime + to Unix Time. It returns an int value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
DateTimedateTimeThe converted DateTime in Unix Time.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 int unix = Time.DateTimeToUnixTime(new(2022, 12, 4, 8, 57, 48, DateTimeKind.Utc)); 
 // unix = 1670144268
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/converters/volumes.html b/docs/core/converters/volumes.html index 83f3f84..4901eea 100644 --- a/docs/core/converters/volumes.html +++ b/docs/core/converters/volumes.html @@ -1,31 +1,1820 @@ - - + + Volumes | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Volumes

This page is about the Volumes class available in PeyrSharp.Core.Converters. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Volumes class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

M3ToLitre(m3)

Definition

Converts Cubic Meters (m³) to Litre (L). Returns a double value.

Arguments

TypeNameMeaning
doublem3Number of cubic meters to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Volumes + +

+

+ This page is about the Volumes class + available in + PeyrSharp.Core.Converters. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Volumes class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ M3ToLitre(m3) + +

+

+ Definition + +

+

+ Converts Cubic Meters (m³) to Litre (L). Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublem3Number of cubic meters to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double litre = Volumes.M3ToLitre(10);
 // litre = 10000
-

LitreToM3(m3)

Definition

Converts Litre (L) to Cubic Meters (m³). Returns a double value.

Arguments

TypeNameMeaning
doublelitreNumber of litres to convert.

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ LitreToM3(m3) + +

+

+ Definition + +

+

+ Converts Litre (L) to Cubic Meters (m³). Returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublelitreNumber of litres to convert.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double m3 = Volumes.LitreToM3(500);
 // m3 = 0.5
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/crypt.html b/docs/core/crypt.html index dd71466..28a6c96 100644 --- a/docs/core/crypt.html +++ b/docs/core/crypt.html @@ -1,26 +1,1735 @@ - - + + Crypt | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Crypt

This page is about the Crypt class available in PeyrSharp.Core. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Crypt class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

EncryptAes(str, key)

Definitions

Encrypts a string using AES encryption. Returns the encrypted content as a string as well.

Arguments

TypeNameMeaning
stringstrThe text to encrypt.
stringkeyThe encryption key. This is the same key that will be used to decrypt the text.

Usage

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Crypt + +

+

+ This page is about the Crypt class + available in + PeyrSharp.Core. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Crypt class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ EncryptAes(str, key) + +

+

+ Definitions + +

+

+ Encrypts a string using AES encryption. + Returns the encrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringstrThe text to encrypt.
stringkey + The encryption key. This is the same key that + will be used to decrypt the text. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string text = "Hello, world!";
 string encrypted = Crypt.EncryptAes(text, "password");
 // encrypted = 8U0HRr7pCIdbvBIquiJaLc00fyBjXDb9sLflk5anIi8=
-

EncryptRsa(str, rsaParameters)

Definitions

Encrypts a string using RSA encryption. Returns the encrypted content as an array of byte (byte[]).

Arguments

TypeNameMeaning
stringstrThe text to encrypt.
RSAParametersrsaParametersThe RSA key.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ EncryptRsa(str, rsaParameters) + +

+

+ Definitions + +

+

+ Encrypts a string using RSA encryption. + Returns the encrypted content as an array of + byte (byte[]). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringstrThe text to encrypt.
RSAParametersrsaParametersThe RSA key.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 using System.Security.Cryptography;
 
 string text = "Hello, world!";
@@ -30,17 +1739,236 @@
 
 // Encrypt using RSA
 string encrypted = Crypt.EncryptRsa(text, cryptoServiceProvider.ExportParameters(false));
-

Encrypt3Des(source, key)

Definitions

Encrypts a string using AES encryption. Returns the encrypted content as a string as well.

Arguments

TypeNameMeaning
stringsourceThe text to encrypt.
stringkeyThe encryption key. This is the same key that will be used to decrypt the text.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ Encrypt3Des(source, key) + +

+

+ Definitions + +

+

+ Encrypts a string using AES encryption. + Returns the encrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringsourceThe text to encrypt.
stringkey + The encryption key. This is the same key that + will be used to decrypt the text. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string text = "Hello, world!";
 string encrypted = Crypt.Encrypt3Des(text, "password");
 // encrypted = bxceEpCfRlbyYdPggAu+Cw==
-

DecryptAes(str, key)

Definitions

Decrypts a string using AES encryption. Returns the decrypted content as a string as well.

Arguments

TypeNameMeaning
stringstrThe text to decrypt.
stringkeyThe encryption key that was used during the encryption process.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ DecryptAes(str, key) + +

+

+ Definitions + +

+

+ Decrypts a string using AES encryption. + Returns the decrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringstrThe text to decrypt.
stringkey + The encryption key that was used during the + encryption process. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string encrypted = "6NvvTBntd2PdFxXzVbccLw==";
 string text = Crypt.DecryptAes(encrypted, "password");
 // text = Hello!
-

DecryptRsa(encrypted, rsaParameters)

Definitions

Decrypts a string using AES encryption. Returns the decrypted content as a string as well.

Arguments

TypeNameMeaning
byte[]encryptedThe text to decrypt.
RSAParametersrsaParametersThe encryption key that was used during the encryption process.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ DecryptRsa(encrypted, rsaParameters) + +

+

+ Definitions + +

+

+ Decrypts a string using AES encryption. + Returns the decrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
byte[]encryptedThe text to decrypt.
RSAParametersrsaParameters + The encryption key that was used during the + encryption process. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 using System.Security.Cryptography;
 
 RSACryptoServiceProvider cryptoServiceProvider = new RSACryptoServiceProvider();
@@ -48,14 +1976,177 @@
 
 string decrypted = Crypt.DecryptRsa(e, cryptoServiceProvider.ExportParameters(true));
 // decrypted = Hello
-

Decrypt3Des(str, key)

Definitions

Decrypts a string using 3-DES encryption. Returns the decrypted content as a string as well.

Arguments

TypeNameMeaning
stringencryptThe text to decrypt.
stringkeyThe encryption key that was used during the encryption process.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ Decrypt3Des(str, key) + +

+

+ Definitions + +

+

+ Decrypts a string using 3-DES encryption. + Returns the decrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringencryptThe text to decrypt.
stringkey + The encryption key that was used during the + encryption process. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string encrypted = "AvuLd4LUxRU=";
 string text = Crypt.Decrypt3Des(encrypted, "123");
 // text = Hello
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/guid-options.html b/docs/core/guid-options.html index dace9e5..e30a568 100644 --- a/docs/core/guid-options.html +++ b/docs/core/guid-options.html @@ -1,21 +1,1625 @@ - - + + GuidOptions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

GuidOptions

This page is about the GuidOptions class available in PeyrSharp.Core. You can find here all of its properties.

Compatibility

The GuidOptions class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

GuidOptions()

Definition

Initializes GuidOptions with default values for its properties.

Usage

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ GuidOptions + +

+

+ This page is about the GuidOptions class + available in PeyrSharp.Core. You can find here all of + its properties. +

+

+ Compatibility + +

+

+ The GuidOptions class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ GuidOptions() + +

+

+ Definition + +

+

+ Initializes GuidOptions with default + values for its properties. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 var options = new GuidOptions();
 /*
@@ -25,7 +1629,48 @@
         - Braces = false
         - UpperCaseOnly = false
 */
-

GuidOptions(length, hyphens, braces, upperCaseOnly)

Definition

Initializes GuidOptions with specific values for its properties.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GuidOptions(length, hyphens, braces, upperCaseOnly) + +

+

+ Definition + +

+

+ Initializes GuidOptions with specific + values for its properties. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 var options = new GuidOptions(32, true, true, true);
 /*
@@ -35,13 +1680,312 @@
         - Braces = true
         - UpperCaseOnly = true
 */
-

Properties

Length

Definition

c#
public int Length { get; set; }
-

The Length property is an int representing the length of the Guid that will be generated if used with GuidGen.Generate().

INFO

This property can be initialized when using the GuidOptions(length, hyphens, braces, upperCaseOnly) constructor.

You can get and set this property after initializing the class.

Hyphens

Definition

c#
public bool Hyphens { get; set; }
-

The Hyphens property is a bool, which will determine if you want hyphens in the Guid that will be generated if used with GuidGen.Generate().

INFO

This property can be initialized when using the GuidOptions(length, hyphens, braces, upperCaseOnly) constructor.

You can get and set this property after initializing the class.

Braces

Definition

c#
public bool Braces { get; set; }
-

The Braces property is a bool, which will determine if you want braces in the Guid that will be generated if used with GuidGen.Generate().

INFO

This property can be initialized when using the GuidOptions(length, hyphens, braces, upperCaseOnly) constructor.

You can get and set this property after initializing the class.

UpperCaseOnly

Definition

c#
public bool UpperCaseOnly { get; set; }
-

The UpperCaseOnly property is a bool, which will determine if you want to only have upper cases in the Guid that will be generated if used with GuidGen.Generate().

INFO

This property can be initialized when using the GuidOptions(length, hyphens, braces, upperCaseOnly) constructor.

You can get and set this property after initializing the class.

Released under the MIT License.

- - +
+
+

+ Properties + +

+

+ Length + +

+

+ Definition + +

+
+ c# +
public int Length { get; set; }
+
+
+

+ The Length property is an + int representing the length of the Guid + that will be generated if used with + GuidGen.Generate(). +

+
+

INFO

+

+ This property can be initialized when using the + GuidOptions(length, hyphens, braces, + upperCaseOnly) + constructor. +

+
+

+ You can get and set this + property after initializing the class. +

+

+ Hyphens + +

+

+ Definition + +

+
+ c# +
public bool Hyphens { get; set; }
+
+
+

+ The Hyphens property is a + bool, which will determine if you want + hyphens in the Guid that will be generated if used + with GuidGen.Generate(). +

+
+

INFO

+

+ This property can be initialized when using the + GuidOptions(length, hyphens, braces, + upperCaseOnly) + constructor. +

+
+

+ You can get and set this + property after initializing the class. +

+

+ Braces + +

+

+ Definition + +

+
+ c# +
public bool Braces { get; set; }
+
+
+

+ The Braces property is a + bool, which will determine if you want + braces in the Guid that will be generated if used with + GuidGen.Generate(). +

+
+

INFO

+

+ This property can be initialized when using the + GuidOptions(length, hyphens, braces, + upperCaseOnly) + constructor. +

+
+

+ You can get and set this + property after initializing the class. +

+

+ UpperCaseOnly + +

+

+ Definition + +

+
+ c# +
public bool UpperCaseOnly { get; set; }
+
+
+

+ The UpperCaseOnly property is a + bool, which will determine if you want to + only have upper cases in the Guid that will be + generated if used with + GuidGen.Generate(). +

+
+

INFO

+

+ This property can be initialized when using the + GuidOptions(length, hyphens, braces, + upperCaseOnly) + constructor. +

+
+

+ You can get and set this + property after initializing the class. +

+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/guid.html b/docs/core/guid.html index db91a91..856d112 100644 --- a/docs/core/guid.html +++ b/docs/core/guid.html @@ -1,39 +1,1988 @@ - - + + GuidGen | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

GuidGen

This page is about the GuidGen class available in PeyrSharp.Core. You can find here all of its methods and properties.

INFO

This class is static.

Compatibility

The GuidGen class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

Generate()

Definition

The Generate() method generates a Guid and will return it as a string.

INFO

This method has different overloads.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ GuidGen + +

+

+ This page is about the GuidGen class + available in PeyrSharp.Core. You can find here all of + its methods and properties. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The GuidGen class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ Generate() + +

+

+ Definition + +

+

+ The Generate() method generates a Guid + and will return it as a string. +

+
+

INFO

+

This method has different overloads.

+
+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string guid = GuidGen.Generate();
 // guid = 7992acdd-1c9a-4985-92df-04599d560bbc (example)
-

Generate(length)

Definition

The Generate() method generates a Guid with a specific length and will return it as a string.

INFO

This method is an overload of Generate()

Arguments

This method has one argument:

TypeNameMeaning
intlengthThe length of the Guid.

WARNING

The length must be a number, otherwise, it will thrown a InvalidGuidLengthException.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ Generate(length) + +

+

+ Definition + +

+

+ The Generate() method generates a Guid + with a specific length and will return it as a + string. +

+
+

INFO

+

+ This method is an overload of + Generate() +

+
+

+ Arguments + +

+

This method has one argument:

+ + + + + + + + + + + + + + + +
TypeNameMeaning
intlengthThe length of the Guid.
+
+

WARNING

+

+ The length must be a number, otherwise, + it will thrown a + InvalidGuidLengthException. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string guid = GuidGen.Generate(15);
 // guid = 5693ad99881e4f9 (example)
-

Generate(fromString)

Definition

The Generate() method generates a Guid from a specific string and will return it as a string.

INFO

This method is an overload of Generate()

Arguments

This method has one argument:

TypeNameMeaning
stringfromStringThe string which will be used to generate the Guid.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ Generate(fromString) + +

+

+ Definition + +

+

+ The Generate() method generates a Guid + from a specific string and will return it + as a string. +

+
+

INFO

+

+ This method is an overload of + Generate() +

+
+

+ Arguments + +

+

This method has one argument:

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringfromString + The string which will be used to generate the + Guid. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string guid = GuidGen.Generate("Hello");
 // guid = 53991a8b-61c4-9612-a827-abf8c47804d7
-

Generate(guidOptions)

Definition

The Generate() method generates a Guid with specific GuidOptions and will return it as a string.

INFO

This method is an overload of Generate()

Arguments

This method has one argument:

TypeNameMeaning
GuidOptionsguidOptionsThe options of the Guid to generate.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ Generate(guidOptions) + +

+

+ Definition + +

+

+ The Generate() method generates a Guid + with specific + GuidOptions + and will return it as a string. +

+
+

INFO

+

+ This method is an overload of + Generate() +

+
+

+ Arguments + +

+

This method has one argument:

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ GuidOptions + guidOptionsThe options of the Guid to generate.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string guid = Guid.Generate(new GuidOptions(32, true, true, false));
 // guid = {35c3ab90-7636-4d34-a439-bc65eb3c} (example)
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/internet.html b/docs/core/internet.html index a36e67e..7368153 100644 --- a/docs/core/internet.html +++ b/docs/core/internet.html @@ -1,47 +1,1942 @@ - - + + Internet | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Internet

This page is about the Internet class available in PeyrSharp.Core. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Internet class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

IsAvailableAsync()

Definition

Checks if a connection to the Internet is available. Returns a bool value.

INFO

This method is asynchronous and awaitable.

Arguments

This method has no arguments

Usage

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Internet + +

+

+ This page is about the Internet class + available in + PeyrSharp.Core. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Internet class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ IsAvailableAsync() + +

+

+ Definition + +

+

+ Checks if a connection to the Internet is available. + Returns a bool value. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+

This method has no arguments

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 public static async void Main()
 {
     bool isConnected = await Internet.IsAvailableAsync();
 }
-

IsAvailableAsync(url)

Definition

Checks if a connection to the Internet is available. Returns a bool value.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlThe page where to check if Internet is available.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ IsAvailableAsync(url) + +

+

+ Definition + +

+

+ Checks if a connection to the Internet is available. + Returns a bool value. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurl + The page where to check if Internet is + available. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 public static async void Main()
 {
     bool isConnected = await Internet.IsAvailableAsync("https://google.com");
 }
-

GetStatusCodeAsync(url)

Definition

Gets the status code of a specific page by making a request to it. Returns the status code as an int value.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlThe URL where to send the request.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GetStatusCodeAsync(url) + +

+

+ Definition + +

+

+ Gets the status code of a specific page by making a + request to it. Returns the status code as an + int value. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurlThe URL where to send the request.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 public static async void Main()
 {
     int status = await Internet.GetStatusCodeAsync("https://google.com");
     // status should be 200 if everything is working
 }
-

GetStatusDescriptionAsync(url)

Definition

Gets the status description of a specific page by making a request to it. Returns the status description as a string.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlThe URL where to send the request.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GetStatusDescriptionAsync(url) + +

+

+ Definition + +

+

+ Gets the status description of a specific page by + making a request to it. Returns the status description + as a string. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurlThe URL where to send the request.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 public static async void Main()
 {
     string status = await Internet.GetStatusDescriptionAsync("https://google.com");
     // status should be OK if everything is working
 }
-

GetStatusCodeType(statusCode)

Definition

Gets the type of the status code. Returns a StatusCodes value.

Arguments

TypeNameMeaning
intstatusCodeThe status code to analyze.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GetStatusCodeType(statusCode) + +

+

+ Definition + +

+

+ Gets the type of the status code. Returns a + StatusCodes + value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
intstatusCodeThe status code to analyze.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 using PeyrSharp.Enums;
 
 public static async void Main()
@@ -66,17 +1961,256 @@
             break;
     }
 }
-

GetUrlProtocol(url)

Definition

Gets the protocol of a specified URL. Returns a string.

Arguments

TypeNameMeaning
stringurlThe URL where to parse.

WARNING

If you provide an invalid URL, the result might be wrong or be something unexpected. An IndexOutOfRangeException can also be thrown.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GetUrlProtocol(url) + +

+

+ Definition + +

+

+ Gets the protocol of a specified URL. Returns a + string. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurlThe URL where to parse.
+
+

WARNING

+

+ If you provide an invalid URL, the result might be + wrong or be something unexpected. An + IndexOutOfRangeException can also be + thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string protocol = Internet.GetUrlProtocol("https://leocorporation.dev");
 // protocol = https
-

IsUrlValid(url)

Definition

Checks if a URL is valid or not.. Returns a bool.

Arguments

TypeNameMeaning
stringurlThe URL where to check.

INFO

If you haven't specified the protocol in the URL (ex: "https://"), the "https://" string will automatically be appended to the original URL. To avoid this behavior, please specify a full URL to preserve the original protocol.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ IsUrlValid(url) + +

+

+ Definition + +

+

+ Checks if a URL is valid or not.. Returns a + bool. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurlThe URL where to check.
+
+

INFO

+

+ If you haven't specified the protocol in the URL + (ex: "https://"), the + "https://" string will + automatically be appended to the original URL. To + avoid this behavior, please specify a full URL to + preserve the original protocol. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 bool valid = Internet.GetUrlProtocol("a/test");
 // valid = false
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths.html b/docs/core/maths.html index 5bb26c6..8492618 100644 --- a/docs/core/maths.html +++ b/docs/core/maths.html @@ -1,23 +1,1762 @@ - - + + Maths | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Maths

This page is about the Maths namespace available in PeyrSharp.Core. You can find here all of its classes.

Compatibility

The Maths namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Maths + +

+

+ This page is about the Maths namespace + available in + PeyrSharp.Core. You can find here all of its classes. +

+

+ Compatibility + +

+

+ The Maths namespace is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/algebra.html b/docs/core/maths/algebra.html index 8fdae2e..8467e96 100644 --- a/docs/core/maths/algebra.html +++ b/docs/core/maths/algebra.html @@ -1,21 +1,1657 @@ - - + + Algebra | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Algebra

This page is about the Algebra class available in PeyrSharp.Core.Maths. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Algebra class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

Sum(numbers) (double)

Definition

Returns the sum of specified double numbers. It returns a double value.

Arguments

TypeNameMeaning
params double[]numbersThe numbers to do the sum of.

Usage

c#
using PeyrSharp.Core.Maths;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Algebra + +

+

+ This page is about the Algebra class + available in + PeyrSharp.Core.Maths. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Algebra class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ Sum(numbers) (double) + +

+

+ Definition + +

+

+ Returns the sum of specified + double numbers. It returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
params double[]numbersThe numbers to do the sum of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 // Usage 1
 double sum = Algebra.Sum(12, 1.5, 45, 2.2);
@@ -26,7 +1662,70 @@
 
 double sum2 = Algebra.Sum(numbers);
 // sum = 6
-

Sum(numbers) (int)

Definition

Returns the sum of specified int numbers. It returns a int value.

Arguments

TypeNameMeaning
params int[]numbersThe numbers to do the sum of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ Sum(numbers) (int) + +

+

+ Definition + +

+

+ Returns the sum of specified int numbers. + It returns a int value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
params int[]numbersThe numbers to do the sum of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 // Usage 1
 int sum = Algebra.Sum(12, 15, 45, 2);
@@ -37,33 +1736,515 @@
 
 int sum2 = Algebra.Sum(numbers);
 // sum = 6
-

IsInt(number)

Definition

Returns true if a specified double is an integer. It returns a bool value.

Arguments

TypeNameMeaning
doublenumberThe number to check.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ IsInt(number) + +

+

+ Definition + +

+

+ Returns true if a specified + double is an integer. It returns a + bool value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublenumberThe number to check.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 bool isInt = Algebra.IsInt(12.0);
 // isInt = true
-

GetOpposite(number)

Definition

Gets the opposite of a double number. It returns a double value.

Arguments

TypeNameMeaning
doublenumberThe number to get the opposite of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ GetOpposite(number) + +

+

+ Definition + +

+

+ Gets the opposite of a double number. It + returns a double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublenumberThe number to get the opposite of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double opposite = Algebra.Opposite(7);
 // opposite = -7
-

Factorial(number)

Definition

Gets the factorial of an int number. It returns an int.

Arguments

TypeNameMeaning
intnumberThe number to get the factorial of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ Factorial(number) + +

+

+ Definition + +

+

+ Gets the factorial of an int number. It + returns an int. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
intnumberThe number to get the factorial of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 int factorial = Algebra.Factorial(5);
 // factorial = 120
-

PositiveOf(number)

Definition

Gets the positive of a double number. It returns a double value.

Arguments

TypeNameMeaning
doublenumberThe number to get the positive of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ PositiveOf(number) + +

+

+ Definition + +

+

+ Gets the positive of a double number. It + returns a double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublenumberThe number to get the positive of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double pos = Algebra.PositiveOf(-7);
 // pos = 7
-

NegativeOf(number)

Definition

Gets the negative of a double number. It returns a double value.

Arguments

TypeNameMeaning
doublenumberThe number to get the negative of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ NegativeOf(number) + +

+

+ Definition + +

+

+ Gets the negative of a double number. It + returns a double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublenumberThe number to get the negative of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double negative = Algebra.NegativeOf(7);
 // negative = -7
-

GetResultsOf(function, numbers)

Definition

Gets the results of a function applied to specific double numbers. It returns an array of double[].

Arguments

TypeNameMeaning
Func<double, double>functionThe function to apply to all numbers. It must return a double and take a double as an argument.
params double[]numbersThe numbers to get the results of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ GetResultsOf(function, numbers) + +

+

+ Definition + +

+

+ Gets the results of a function applied to specific + double numbers. It returns an array of + double[]. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
Func<double, double>function + The function to apply to all numbers. It must + return a double and take a double as an + argument. +
params double[]numbersThe numbers to get the results of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double res = Algebra.GetResultsOf(x => x * x, 1, 2, 3, 4);
 // res = double[] { 1, 4, 9, 16 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry.html b/docs/core/maths/geometry.html index abff577..88a9069 100644 --- a/docs/core/maths/geometry.html +++ b/docs/core/maths/geometry.html @@ -1,23 +1,1730 @@ - - + + Geometry | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Geometry

This page is about the Geometry namespace available in PeyrSharp.Core.Maths. This namespace includes several classes to get and calculates various aspects of different shapes, like the area, perimeter, volume and more.

Compatibility

The namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Geometry + +

+

+ This page is about the Geometry namespace + available in PeyrSharp.Core.Maths. This + namespace includes several classes to get and + calculates various aspects of different shapes, like + the area, perimeter, volume and more. +

+

+ Compatibility + +

+

+ The namespace is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/circle.html b/docs/core/maths/geometry/circle.html index 55f8756..db99aef 100644 --- a/docs/core/maths/geometry/circle.html +++ b/docs/core/maths/geometry/circle.html @@ -1,40 +1,1873 @@ - - + + Circle | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Circle

This page is about the Circle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Circle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Circle(radius)

Definition

Initializes a Circle class from a specific radius.

Arguments

TypeNameMeaning
doubleradiusThe radius of the circle.

WARNING

If radius ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Circle + +

+

+ This page is about the Circle class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Circle class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Circle(radius) + +

+

+ Definition + +

+

+ Initializes a Circle class from a + specific radius. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleradiusThe radius of the circle.
+
+

WARNING

+

+ If radius ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Circle circle = new(10); // Creates a circle with a radius of 10
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the circle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + circle. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Circle circle = new(10);
 
 var area = circle.Area;
 // area = 314.1592653589793
-

Perimeter

Definition

c#
public double Perimeter { get; }
-

The Perimeter property is a double which returns the perimeter of the circle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Perimeter + +

+

+ Definition + +

+
+ c# +
public double Perimeter { get; }
+
+
+

+ The Perimeter property is a + double which returns the perimeter of the + circle. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Circle circle = new(10);
 
 var perimeter = circle.Perimeter;
 // perimeter = 62.83185307179586
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/cone.html b/docs/core/maths/geometry/cone.html index 653665e..76a7142 100644 --- a/docs/core/maths/geometry/cone.html +++ b/docs/core/maths/geometry/cone.html @@ -1,47 +1,1931 @@ - - + + Cone | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Cone

This page is about the Cone class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Cone class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Cone(radius, height)

Definition

Initializes a Cone class from a specific radius and height.

Arguments

TypeNameMeaning
doubleradiusThe radius of the cone.
doubleheightThe height of the cone.

WARNING

If radius or height ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Cone + +

+

+ This page is about the Cone class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Cone class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Cone(radius, height) + +

+

+ Definition + +

+

+ Initializes a Cone class from a specific + radius and height. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubleradiusThe radius of the cone.
doubleheightThe height of the cone.
+
+

WARNING

+

+ If radius or height ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cone cone = new(10, 20); // Creates a cone with a radius of 10, and a height of 20
-

Properties

Volume

Definition

c#
public double Volume { get; }
-

The Volume property is a double which returns the volume of the cone. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Volume + +

+

+ Definition + +

+
+ c# +
public double Volume { get; }
+
+
+

+ The Volume property is a + double which returns the volume of the + cone. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cone cone = new(10, 20);
 
 var volume = cone.Volume;
 // volume = 2094.3951023931954
-

Radius

Definition

c#
public double Radius { get; init; }
-

The Radius property is a double which returns the radius of the cone, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Radius + +

+

+ Definition + +

+
+ c# +
public double Radius { get; init; }
+
+
+

+ The Radius property is a + double which returns the radius of the + cone, which was defined when initializing it. You can + only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cone cone = new(15, 20);
 
 var radius = cone.Radius;
 // radius = 15
-

Height

Definition

c#
public double Height { get; init; }
-

The Height property is a double which returns the height of the cone, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Height + +

+

+ Definition + +

+
+ c# +
public double Height { get; init; }
+
+
+

+ The Height property is a + double which returns the height of the + cone, which was defined when initializing it. You can + only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Circle cone = new(10, 40);
 
 var height = cone.Height;
 // height = 40
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/cube.html b/docs/core/maths/geometry/cube.html index 81a46a5..438a100 100644 --- a/docs/core/maths/geometry/cube.html +++ b/docs/core/maths/geometry/cube.html @@ -1,78 +1,2232 @@ - - + + Cube | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Cube

This page is about the Cube class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Cube class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Cube(side)

Definition

Initializes a Cube class from the length of the side of the cube.

Arguments

TypeNameMeaning
doublesideThe length of the side of the cube.

WARNING

If side ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Cube + +

+

+ This page is about the Cube class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Cube class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Cube(side) + +

+

+ Definition + +

+

+ Initializes a Cube class from the length + of the side of the cube. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublesideThe length of the side of the cube.
+
+

WARNING

+

+ If side ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10); // Creates a 10x10x10 cube
-

Cube(width, length, height)

Definition

Initializes a Cube class from the width, the length and the height of the cuboidal.

Arguments

TypeNameMeaning
doublewidthThe width of the cuboidal.
doublelengthThe length of the cuboidal.
doubleheightThe height of the cuboidal.

WARNING

If width, length or height ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Cube(width, length, height) + +

+

+ Definition + +

+

+ Initializes a Cube class from the width, + the length and the height of the cuboidal. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublewidthThe width of the cuboidal.
doublelengthThe length of the cuboidal.
doubleheightThe height of the cuboidal.
+
+

WARNING

+

+ If width, length or + height ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10, 20, 10); // Creates a 10x20x10 cuboidal
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var area = cube.Area;
 // area = 100
-

Edge

Definition

c#
public double Edge { get; }
-

The Edge property is a double which returns the edge of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Edge + +

+

+ Definition + +

+
+ c# +
public double Edge { get; }
+
+
+

+ The Edge property is a + double which returns the edge of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var edge = cube.Edge;
 // edge = 7.0710678118654755
-

Length

Definition

c#
public double Length { get; init; }
-

The Length property is a double which returns the length of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Length + +

+

+ Definition + +

+
+ c# +
public double Length { get; init; }
+
+
+

+ The Length property is a + double which returns the length of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var length = cube.Length;
 // length = 10
-

Height

Definition

c#
public double Height { get; init; }
-

The Height property is a double which returns the height of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Height + +

+

+ Definition + +

+
+ c# +
public double Height { get; init; }
+
+
+

+ The Height property is a + double which returns the height of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var height = cube.Height;
 // height = 10
-

Side

Definition

c#
public double? Side { get; init; }
-

The Side property is a double? which returns the length of the side of the cube. You can only get this property.

WARNING

This property can be null if not initialized with Cube(side).

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side + +

+

+ Definition + +

+
+ c# +
public double? Side { get; init; }
+
+
+

+ The Side property is a + double? which returns the length of the + side of the cube. You can only get this + property. +

+
+

WARNING

+

+ This property can be null if not + initialized with + Cube(side). +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var side = cube.Side ?? 0;
 // side = 10
-

Volume

Definition

c#
public double Volume { get; }
-

The Volume property is a double which returns the volume of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Volume + +

+

+ Definition + +

+
+ c# +
public double Volume { get; }
+
+
+

+ The Volume property is a + double which returns the volume of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var volume = cube.Volume; // 10^3
 // volume = 1000
-

Width

Definition

c#
public double Width { get; init; }
-

The Width property is a double which returns the width of the cube. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Width + +

+

+ Definition + +

+
+ c# +
public double Width { get; init; }
+
+
+

+ The Width property is a + double which returns the width of the + cube. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cube cube = new(10);
 
 var width = cube.Width;
 // width = 10
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/cylinder.html b/docs/core/maths/geometry/cylinder.html index d1e3c6d..8480831 100644 --- a/docs/core/maths/geometry/cylinder.html +++ b/docs/core/maths/geometry/cylinder.html @@ -1,54 +1,1985 @@ - - + + Cylinder | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Cylinder

This page is about the Cylinder class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Cylinder class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Cylinder(radius, height)

Definition

Initializes a Cylinder class from a specific radius and height.

Arguments

TypeNameMeaning
doubleradiusThe radius of the cylinder.
doubleheightThe height of the cylinder.

WARNING

If radius or height ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Cylinder + +

+

+ This page is about the Cylinder class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Cylinder class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Cylinder(radius, height) + +

+

+ Definition + +

+

+ Initializes a Cylinder class from a + specific radius and height. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubleradiusThe radius of the cylinder.
doubleheightThe height of the cylinder.
+
+

WARNING

+

+ If radius or height ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cylinder cylinder = new(20, 10); // Creates a cylinder with a radius of 20, and a height of 10
-

Properties

Volume

Definition

c#
public double Volume { get; }
-

The Volume property is a double which returns the volume of the cylinder. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Volume + +

+

+ Definition + +

+
+ c# +
public double Volume { get; }
+
+
+

+ The Volume property is a + double which returns the volume of the + cylinder. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cylinder cylinder = new(10, 20);
 
 var volume = cylinder.Volume;
 // volume = 6283.185307179587
-

BaseArea

Definition

c#
public double BaseArea { get; }
-

The BaseArea property is a double which returns the area of the circle, which is the base of the cylinder. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ BaseArea + +

+

+ Definition + +

+
+ c# +
public double BaseArea { get; }
+
+
+

+ The BaseArea property is a + double which returns the area of the + circle, which is the base of the cylinder. You can + only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cylinder cylinder = new(10, 20);
 
 var baseArea = cylinder.BaseArea;
 // baseArea = 314.1592653589793
-

Radius

Definition

c#
public double Radius { get; init; }
-

The Radius property is a double which returns the radius of the cylinder, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Radius + +

+

+ Definition + +

+
+ c# +
public double Radius { get; init; }
+
+
+

+ The Radius property is a + double which returns the radius of the + cylinder, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cylinder cylinder = new(15, 20);
 
 var radius = cylinder.Radius;
 // radius = 15
-

Height

Definition

c#
public double Height { get; init; }
-

The Height property is a double which returns the height of the cylinder, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Height + +

+

+ Definition + +

+
+ c# +
public double Height { get; init; }
+
+
+

+ The Height property is a + double which returns the height of the + cylinder, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Cylinder cylinder = new(10, 40);
 
 var height = cylinder.Height;
 // height = 40
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/diamond.html b/docs/core/maths/geometry/diamond.html index ae3b5f7..c7c5088 100644 --- a/docs/core/maths/geometry/diamond.html +++ b/docs/core/maths/geometry/diamond.html @@ -1,58 +1,2082 @@ - - + + Diamond | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Diamond

This page is about the Diamond class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Diamond class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Diamond(side)

Definition

Initializes a Diamond class from the length of its side.

Arguments

TypeNameMeaning
doublesideThe length of the side.

WARNING

If side ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Diamond + +

+

+ This page is about the Diamond class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Diamond class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Diamond(side) + +

+

+ Definition + +

+

+ Initializes a Diamond class from the + length of its side. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublesideThe length of the side.
+
+

WARNING

+

+ If side ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Diamond diamond = new(5); // Creates a diamond where all the sides equals to 5.
-

Diamond(diagonal1, diagonal2)

Definition

Initializes a Diamond class from the length of its diagonals.

Arguments

TypeNameMeaning
doublediagonal1The length of the first diagonal.
doublediagonal2The side of the second diagonal.

WARNING

If diagonal1 or diagonal2 ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Diamond(diagonal1, diagonal2) + +

+

+ Definition + +

+

+ Initializes a Diamond class from the + length of its diagonals. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublediagonal1The length of the first diagonal.
doublediagonal2The side of the second diagonal.
+
+

WARNING

+

+ If diagonal1 or + diagonal2 ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 // Creates a diamond where the first diagonal is equal to 5, and the second one is equal to 10.
 Diamond diamond = new(5, 10); 
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the diamond. You can only get this property.

WARNING

This property can be null or can return 0 if not initialized with Diamond(diagonal1, diagonal2).

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + diamond. You can only get this property. +

+
+

WARNING

+

+ This property can be null or can return + 0 if not initialized with + Diamond(diagonal1, diagonal2). +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Diamond diamond = new(5, 10);
 
 var area = diamond.Area;
 // area = 100
-

Perimeter

Definition

c#
public double Perimeter { get; }
-

The Perimeter property is a double which returns the perimeter of the diamond. You can only get this property.

WARNING

This property can be null or can return 0 if not initialized with Diamond(side).

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Perimeter + +

+

+ Definition + +

+
+ c# +
public double Perimeter { get; }
+
+
+

+ The Perimeter property is a + double which returns the perimeter of the + diamond. You can only get this property. +

+
+

WARNING

+

+ This property can be null or can return + 0 if not initialized with + Diamond(side). +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Diamond diamond = new(10);
 
 var perimeter = diamond.Perimeter;
 // perimeter = 40
-

Side

Definition

c#
public double Side { get; init; }
-

The Side property is a double which returns the length of sides of the diamond, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side + +

+

+ Definition + +

+
+ c# +
public double Side { get; init; }
+
+
+

+ The Side property is a + double which returns the length of sides + of the diamond, which was defined when initializing + it. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Diamond diamond = new(10);
 
 var side = diamond.Side;
 // side = 10
-

Diagonals

Definition

c#
public double[] Diagonals { get; init; }
-

The Side property is a double[] array which returns the diagonals of the diamond, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Diagonals + +

+

+ Definition + +

+
+ c# +
public double[] Diagonals { get; init; }
+
+
+

+ The Side property is a + double[] array which returns the + diagonals of the diamond, which was defined when + initializing it. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Diamond diamond = new(10, 14);
 
 var side = diamond.Diagonals;
 // side = { 10, 14 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/hexagon.html b/docs/core/maths/geometry/hexagon.html index 7a75992..5111794 100644 --- a/docs/core/maths/geometry/hexagon.html +++ b/docs/core/maths/geometry/hexagon.html @@ -1,46 +1,1924 @@ - - + + Hexagon | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Hexagon

This page is about the Hexagon class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Hexagon class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Hexagon(side)

Definition

Initializes a Hexagon class from the length of its side.

Arguments

TypeNameMeaning
doublesideThe length of the side of the hexagon.

WARNING

If side ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Hexagon + +

+

+ This page is about the Hexagon class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Hexagon class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Hexagon(side) + +

+

+ Definition + +

+

+ Initializes a Hexagon class from the + length of its side. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doublesideThe length of the side of the hexagon.
+
+

WARNING

+

+ If side ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Hexagon hexagon = new(12); // Creates a hexagon with a length of 12
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the hexagon. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + hexagon. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Hexagon hexagon = new(12);
 
 var area = hexagon.Area;
 // area = 374.1229744348775
-

Perimeter

Definition

c#
public double Perimeter { get; }
-

The Perimeter property is a double which returns the perimeter of the hexagon. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Perimeter + +

+

+ Definition + +

+
+ c# +
public double Perimeter { get; }
+
+
+

+ The Perimeter property is a + double which returns the perimeter of the + hexagon. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Hexagon hexagon = new(12);
 
 var perimeter = hexagon.Perimeter;
 // perimeter = 72
-

Side

Definition

c#
public double Side { get; init; }
-

The Side property is a double which returns the length of the side of the hexagon. You can only get this property

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side + +

+

+ Definition + +

+
+ c# +
public double Side { get; init; }
+
+
+

+ The Side property is a + double which returns the length of the + side of the hexagon. You can only + get this property +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Hexagon hexagon = new(10);
 
 var side = hexagon.Side; // side = 10
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/pyramid.html b/docs/core/maths/geometry/pyramid.html index 13aca7a..2480e31 100644 --- a/docs/core/maths/geometry/pyramid.html +++ b/docs/core/maths/geometry/pyramid.html @@ -1,84 +1,2392 @@ - - + + Pyramid | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Pyramid

This page is about the Pyramid class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors, methods and properties.

Compatibility

The Pyramid class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Pyramid(width, length, height)

Definition

Initializes a Pyramid class from a specific width, length, and height.

Arguments

TypeNameMeaning
doublewidthThe width of the pyramid.
doublelengthThe length of the pyramid.
doubleheightThe height of the pyramid.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Pyramid + +

+

+ This page is about the Pyramid class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors, methods + and properties. +

+

+ Compatibility + +

+

+ The Pyramid class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Pyramid(width, length, height) + +

+

+ Definition + +

+

+ Initializes a Pyramid class from a + specific width, length, and height. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublewidthThe width of the pyramid.
doublelengthThe length of the pyramid.
doubleheightThe height of the pyramid.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(12, 10, 15); // Creates a pyramid with a width of 12, a length of 10, and a height of 15
-

Methods

FromVolumeAndSize(volume, width, length)

Definition

Initializes a Pyramid class from a specific volume, width, and length.

Arguments

TypeNameMeaning
doublevolumeThe volume of the pyramid.
doublewidthThe width of the pyramid.
doublelengthThe length of the pyramid.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Methods + +

+

+ FromVolumeAndSize(volume, width, length) + +

+

+ Definition + +

+

+ Initializes a Pyramid class from a + specific volume, width, and length. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevolumeThe volume of the pyramid.
doublewidthThe width of the pyramid.
doublelengthThe length of the pyramid.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = Pyramid.FromVolumeAndSize(100, 10, 10);
-

FromAreaAndLength(area, length, height)

Definition

Initializes a Pyramid class from a specific area, length, and height.

Arguments

TypeNameMeaning
doubleareaThe area of the pyramid.
doublelengthThe length of the pyramid.
doubleheightThe height of the pyramid.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ FromAreaAndLength(area, length, height) + +

+

+ Definition + +

+

+ Initializes a Pyramid class from a + specific area, length, and height. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubleareaThe area of the pyramid.
doublelengthThe length of the pyramid.
doubleheightThe height of the pyramid.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = Pyramid.FromAreaAndLength(100, 10, 15);
-

FromAreaAndWidth(area, width, height)

Definition

Initializes a Pyramid class from a specific volume, width, and length.

Arguments

TypeNameMeaning
doubleareaThe area of the pyramid.
doublewidthThe width of the pyramid.
doubleheightThe height of the pyramid.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ FromAreaAndWidth(area, width, height) + +

+

+ Definition + +

+

+ Initializes a Pyramid class from a + specific volume, width, and length. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubleareaThe area of the pyramid.
doublewidthThe width of the pyramid.
doubleheightThe height of the pyramid.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = Pyramid.FromVolumeAndSize(100, 10, 10);
-

Properties

AreaBase

Definition

c#
public double AreaBase { get; }
-

The AreaBase property is a double which returns the area of the pyramid. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ AreaBase + +

+

+ Definition + +

+
+ c# +
public double AreaBase { get; }
+
+
+

+ The AreaBase property is a + double which returns the area of the + pyramid. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(12, 10, 15);
 
 var area = pyramid.AreaBase;
 // area = 120
-

Volume

Definition

c#
public double AreaBase { get; }
-

The Volume property is a double which returns the volume of the pyramid. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Volume + +

+

+ Definition + +

+
+ c# +
public double AreaBase { get; }
+
+
+

+ The Volume property is a + double which returns the volume of the + pyramid. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(12, 10, 15);
 
 var volume = pyramid.Volume;
 // volume = 600
-

LengthBase

Definition

c#
public double LengthBase { get; }
-

The LengthBase property is a double which returns the length of the base of pyramid. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ LengthBase + +

+

+ Definition + +

+
+ c# +
public double LengthBase { get; }
+
+
+

+ The LengthBase property is a + double which returns the length of the + base of pyramid. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(12, 10, 15);
 
 var length = pyramid.LengthBase;
 // length = 10
-

WidthBase

Definition

c#
public double WidthBase { get; }
-

The WidthBase property is a double which returns the width of the base of pyramid. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ WidthBase + +

+

+ Definition + +

+
+ c# +
public double WidthBase { get; }
+
+
+

+ The WidthBase property is a + double which returns the width of the + base of pyramid. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(12, 10, 15);
 
 var width = pyramid.WidthBase;
 // width = 12
-

Width

Definition

c#
public double Width { get; init; }
-

The Width property is a double which returns the width of the pyramid, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Width + +

+

+ Definition + +

+
+ c# +
public double Width { get; init; }
+
+
+

+ The Width property is a + double which returns the width of the + pyramid, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(10, 20, 30);
 
 var width = pyramid.Width;
 // width = 10
-

Length

Definition

c#
public double Length { get; init; }
-

The Length property is a double which returns the length of the pyramid, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Length + +

+

+ Definition + +

+
+ c# +
public double Length { get; init; }
+
+
+

+ The Length property is a + double which returns the length of the + pyramid, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(10, 20, 30);
 
 var length = pyramid.Length;
 // length = 20
-

Height

Definition

c#
public double Height { get; init; }
-

The Height property is a double which returns the height of the pyramid, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Height + +

+

+ Definition + +

+
+ c# +
public double Height { get; init; }
+
+
+

+ The Height property is a + double which returns the height of the + pyramid, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Pyramid pyramid = new(10, 20, 30);
 
 var height = pyramid.Height;
 // height = 30
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/rectangle.html b/docs/core/maths/geometry/rectangle.html index 0288364..92d96a2 100644 --- a/docs/core/maths/geometry/rectangle.html +++ b/docs/core/maths/geometry/rectangle.html @@ -1,61 +1,2040 @@ - - + + Rectangle | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Rectangle

This page is about the Rectangle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Rectangle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Rectangle(width, length)

Definition

Initializes a Rectangle class from a specific length and width.

Arguments

TypeNameMeaning
doublewidthThe width of the rectangle.
doublelengthThe length of the rectangle.

WARNING

If width or length ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Rectangle + +

+

+ This page is about the Rectangle class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Rectangle class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Rectangle(width, length) + +

+

+ Definition + +

+

+ Initializes a Rectangle class from a + specific length and width. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublewidthThe width of the rectangle.
doublelengthThe length of the rectangle.
+
+

WARNING

+

+ If width or length ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 20); // Creates a 10x20 rectangle
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the rectangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + rectangle. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 15);
 
 var area = rectangle.Area;
 // area = 150
-

Perimeter

Definition

c#
public double Perimeter { get; }
-

The Perimeter property is a double which returns the perimeter of the rectangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Perimeter + +

+

+ Definition + +

+
+ c# +
public double Perimeter { get; }
+
+
+

+ The Perimeter property is a + double which returns the perimeter of the + rectangle. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 15);
 
 var perimeter = rectangle.Perimeter;
 // perimeter = 50
-

Diagonal

Definition

c#
public double Diagonal { get; }
-

The Diagonal property is a double which returns the length of the diagonal of the rectangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Diagonal + +

+

+ Definition + +

+
+ c# +
public double Diagonal { get; }
+
+
+

+ The Diagonal property is a + double which returns the length of the + diagonal of the rectangle. You can only + get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 15);
 
 var diagonal = rectangle.Diagonal;
 // diagonal = 18.027756377319946
-

Width

Definition

c#
public double Width { get; init; }
-

The Width property is a double which returns the width of the rectangle, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Width + +

+

+ Definition + +

+
+ c# +
public double Width { get; init; }
+
+
+

+ The Width property is a + double which returns the width of the + rectangle, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 20);
 
 var width = rectangle.Width;
 // width = 10
-

Length

Definition

c#
public double Length { get; init; }
-

The Length property is a double which returns the length of the rectangle, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Length + +

+

+ Definition + +

+
+ c# +
public double Length { get; init; }
+
+
+

+ The Length property is a + double which returns the length of the + rectangle, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Rectangle rectangle = new(10, 20);
 
 var length = rectangle.Length;
 // length = 20
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/sphere.html b/docs/core/maths/geometry/sphere.html index 327a5ea..6323cf0 100644 --- a/docs/core/maths/geometry/sphere.html +++ b/docs/core/maths/geometry/sphere.html @@ -1,47 +1,1929 @@ - - + + Sphere | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Sphere

This page is about the Sphere class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Sphere class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Sphere(radius)

Definition

Initializes a Sphere class from a specific radius.

Arguments

TypeNameMeaning
doubleradiusThe radius of the sphere.

WARNING

If radius ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Sphere + +

+

+ This page is about the Sphere class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Sphere class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Sphere(radius) + +

+

+ Definition + +

+

+ Initializes a Sphere class from a + specific radius. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleradiusThe radius of the sphere.
+
+

WARNING

+

+ If radius ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Sphere sphere = new(10); // Creates a sphere with a radius of 10
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the sphere. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + sphere. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Sphere sphere = new(10);
 
 var area = sphere.Area;
 // area = 1256.6370614359173
-

Volume

Definition

c#
public double Volume { get; }
-

The Volume property is a double which returns the volume of the sphere. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Volume + +

+

+ Definition + +

+
+ c# +
public double Volume { get; }
+
+
+

+ The Volume property is a + double which returns the volume of the + sphere. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Sphere sphere = new(10);
 
 var volume = sphere.Volume;
 // volume = 2356.194490192345
-

Radius

Definition

c#
public double Radius { get; init; }
-

The Radius property is a double which returns the radius of the sphere, which was defined when initializing it. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Radius + +

+

+ Definition + +

+
+ c# +
public double Radius { get; init; }
+
+
+

+ The Radius property is a + double which returns the radius of the + sphere, which was defined when initializing it. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Sphere sphere = new(10);
 
 var radius = sphere.Radius;
 // radius = 10
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/geometry/triangle.html b/docs/core/maths/geometry/triangle.html index c485c48..00077b9 100644 --- a/docs/core/maths/geometry/triangle.html +++ b/docs/core/maths/geometry/triangle.html @@ -1,100 +1,2457 @@ - - + + Triangle | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Triangle

This page is about the Triangle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.

Compatibility

The Triangle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Constructors

Triangle(side1, side2, side3)

Definition

Initializes a Triangle class from the length of its sides.

Arguments

TypeNameMeaning
doubleside1The length of the first side of the triangle.
doubleside2The length of the second side of the triangle.
doubleside3The length of the third side of the triangle.

WARNING

If side1, side2, or side3 ≤ 0, a DivideByZeroException will be thrown.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Triangle + +

+

+ This page is about the Triangle class + available in + PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and + properties. +

+

+ Compatibility + +

+

+ The Triangle class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Constructors + +

+

+ Triangle(side1, side2, side3) + +

+

+ Definition + +

+

+ Initializes a Triangle class from the + length of its sides. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doubleside1 + The length of the first side of the triangle. +
doubleside2 + The length of the second side of the triangle. +
doubleside3 + The length of the third side of the triangle. +
+
+

WARNING

+

+ If side1, side2, or + side3 ≤ 0, a + DivideByZeroException will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20, 10); // Creates a triangle
-

Triangle(width, height)

Definition

Initializes a Triangle class from a width and height.

Arguments

TypeNameMeaning
doublewidthThe width of the triangle.
doubleheightThe height of the triangle.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Triangle(width, height) + +

+

+ Definition + +

+

+ Initializes a Triangle class from a width + and height. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublewidthThe width of the triangle.
doubleheightThe height of the triangle.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20); // Creates a triangle with a width of 10 and a height of 20
-

Properties

Area

Definition

c#
public double Area { get; }
-

The Area property is a double which returns the area of the triangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Properties + +

+

+ Area + +

+

+ Definition + +

+
+ c# +
public double Area { get; }
+
+
+

+ The Area property is a + double which returns the area of the + triangle. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20);
 
 var area = triangle.Area;
 // area = 100
-

Perimeter

Definition

c#
public double Perimeter { get; }
-

The Perimeter property is a double which returns the perimeter of the triangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Perimeter + +

+

+ Definition + +

+
+ c# +
public double Perimeter { get; }
+
+
+

+ The Perimeter property is a + double which returns the perimeter of the + triangle. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 10, 20);
 
 var perimeter = triangle.Perimeter;
 // perimeter = 40
-

Hypotenuse

Definition

c#
public double Hypotenuse { get; }
-

The Hypotenuse property is a double which returns the hypotenuse of the triangle. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Hypotenuse + +

+

+ Definition + +

+
+ c# +
public double Hypotenuse { get; }
+
+
+

+ The Hypotenuse property is a + double which returns the hypotenuse of + the triangle. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 // Assuming the triangle is right
 Triangle triangle = new(3, 4, 5);
 
 var hypotenuse = triangle.Hypotenuse;
 // hypotenuse = 5
-

IsRight

Definition

c#
public bool IsRight { get; }
-

The IsRight property is a bool which returns true if the triangle is right. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ IsRight + +

+

+ Definition + +

+
+ c# +
public bool IsRight { get; }
+
+
+

+ The IsRight property is a + bool which returns true if + the triangle is right. You can only + get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(3, 4, 5);
 
 var right = triangle.IsRight;
 // right = true
-

CanBeBuilt

Definition

c#
public bool CanBeBuilt { get; }
-

The CanBeBuilt property is a bool which returns true if the triangle can be built. You can only get this property.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ CanBeBuilt + +

+

+ Definition + +

+
+ c# +
public bool CanBeBuilt { get; }
+
+
+

+ The CanBeBuilt property is a + bool which returns true if + the triangle can be built. You can only + get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(3, 4, 10);
 
 var canBeBuilt = triangle.CanBeBuilt;
 // canBeBuilt = false
-

Width

Definition

c#
public double Width { get; init; }
-

The Width property is a double which returns the width of the triangle, which was defined when initializing it. You can only get this property.

WARNING

This property can be equal to double.NaN if the class was not initialized with the Triangle(width, height) constructor.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Width + +

+

+ Definition + +

+
+ c# +
public double Width { get; init; }
+
+
+

+ The Width property is a + double which returns the width of the + triangle, which was defined when initializing it. You + can only get this property. +

+
+

WARNING

+

+ This property can be equal to + double.NaN if the class was not + initialized with the + Triangle(width, height) + constructor. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20);
 
 var width = triangle.Width;
 // width = 10
-

Height

Definition

c#
public double Height { get; init; }
-

The Height property is a double which returns the height of the triangle, which was defined when initializing it. You can only get this property.

WARNING

This property can be equal to double.NaN if the class was not initialized with the Triangle(width, height) constructor.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Height + +

+

+ Definition + +

+
+ c# +
public double Height { get; init; }
+
+
+

+ The Height property is a + double which returns the height of the + triangle, which was defined when initializing it. You + can only get this property. +

+
+

WARNING

+

+ This property can be equal to + double.NaN if the class was not + initialized with the + Triangle(width, height) + constructor. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20);
 
 var height = triangle.Height;
 // height = 20
-

Side1

Definition

c#
public double Side1 { get; init; }
-

The Side1 property is a double which returns the length of the first side of the triangle, which was defined when initializing it. You can only get this property.

WARNING

This property can be equal to double.NaN if the class was not initialized with the Triangle(side1, side2, side3) constructor.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side1 + +

+

+ Definition + +

+
+ c# +
public double Side1 { get; init; }
+
+
+

+ The Side1 property is a + double which returns the length of the + first side of the triangle, which was defined when + initializing it. You can only get this + property. +

+
+

WARNING

+

+ This property can be equal to + double.NaN if the class was not + initialized with the + Triangle(side1, side2, side3) + constructor. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20, 15);
 
 var side1 = triangle.Side1;
 // side1 = 10
-

Side2

Definition

c#
public double Side2 { get; init; }
-

The Side2 property is a double which returns the length of the second side of the triangle, which was defined when initializing it. You can only get this property.

WARNING

This property can be equal to double.NaN if the class was not initialized with the Triangle(side1, side2, side3) constructor.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side2 + +

+

+ Definition + +

+
+ c# +
public double Side2 { get; init; }
+
+
+

+ The Side2 property is a + double which returns the length of the + second side of the triangle, which was defined when + initializing it. You can only get this + property. +

+
+

WARNING

+

+ This property can be equal to + double.NaN if the class was not + initialized with the + Triangle(side1, side2, side3) + constructor. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20, 15);
 
 var side2 = triangle.Side2;
 // side2 = 20
-

Side3

Definition

c#
public double Side3 { get; init; }
-

The Side3 property is a double which returns the length of the third side of the triangle, which was defined when initializing it. You can only get this property.

WARNING

This property can be equal to double.NaN if the class was not initialized with the Triangle(side1, side2, side3) constructor.

Usage

c#
using PeyrSharp.Core.Maths.Geometry;
+
+
+

+ Side3 + +

+

+ Definition + +

+
+ c# +
public double Side3 { get; init; }
+
+
+

+ The Side3 property is a + double which returns the length of the + third side of the triangle, which was defined when + initializing it. You can only get this + property. +

+
+

WARNING

+

+ This property can be equal to + double.NaN if the class was not + initialized with the + Triangle(side1, side2, side3) + constructor. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths.Geometry;
 
 Triangle triangle = new(10, 20, 15);
 
 var side3 = triangle.Side3;
 // side3 = 15
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/percentages.html b/docs/core/maths/percentages.html index 0fab3ad..004ce38 100644 --- a/docs/core/maths/percentages.html +++ b/docs/core/maths/percentages.html @@ -1,39 +1,1976 @@ - - + + Percentages | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Percentages

This page is about the Percentages class available in PeyrSharp.Core.Maths. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Percentages class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

IncreaseBy(value, increaseRate)

Definition

Returns the value after an increase of x% as a double.

Arguments

TypeNameMeaning
doublevalueThe original value.
doubleincreaseRateThe increase percentage (as x/100d).

Usage

c#
using PeyrSharp.Core.Maths;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Percentages + +

+

+ This page is about the Percentages class + available in + PeyrSharp.Core.Maths. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Percentages class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ IncreaseBy(value, increaseRate) + +

+

+ Definition + +

+

+ Returns the value after an increase of x% as a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe original value.
doubleincreaseRate + The increase percentage (as + x/100d). +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double price = Percentages.IncreaseBy(100, 10/100d); // Increase the price by 10%
 // price = 110
-

DecreaseBy(value, decreaseRate)

Definition

Returns the value after a decrease of x% as a double.

Arguments

TypeNameMeaning
doublevalueThe original value.
doubledecreaseRateThe decrease percentage (as x/100d).

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ DecreaseBy(value, decreaseRate) + +

+

+ Definition + +

+

+ Returns the value after a decrease of x% as a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
doublevalueThe original value.
doubledecreaseRate + The decrease percentage (as + x/100d). +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double price = Percentages.DecreaseBy(100, 10/100d); // Decrease the price by 10%
 // price = 90
-

GetInvertedEvolutionRate(evolutionRate)

Definition

Gets the coefficient to get back to the original value after a percentage increase/decrease. It returns a double.

Arguments

TypeNameMeaning
doubleevolutionRateThe evolution rate to get the inverse of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ GetInvertedEvolutionRate(evolutionRate) + +

+

+ Definition + +

+

+ Gets the coefficient to get back to the original value + after a percentage increase/decrease. It returns a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleevolutionRateThe evolution rate to get the inverse of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double ev = Percentages.GetInvertedEvolutionRate(1.1);
 // ev = -0.09090909090909094
-

ProportionToPercentageString(proportion)

Definition

Formats a proportion to a string.

Arguments

TypeNameMeaning
doubleproportionThe proportion to get the percentage of.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ ProportionToPercentageString(proportion) + +

+

+ Definition + +

+

Formats a proportion to a string.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
doubleproportionThe proportion to get the percentage of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 double proportion = Percentages.ProportionToPercentageString(0.5);
 // proportion = 50%
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/proba.html b/docs/core/maths/proba.html index 0eaf6be..23f1c9e 100644 --- a/docs/core/maths/proba.html +++ b/docs/core/maths/proba.html @@ -1,21 +1,1703 @@ - - + + Proba | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Proba

This page is about the Proba class available in PeyrSharp.Core.Maths. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Proba class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

GetRandomValue(probabilities)

Definition

Gets a random value based on the specified probabilities. Returns a randomly selected value.

Type parameters

TypeNameMeaning
T-The type of the values to select from.

Parameters

TypeNameMeaning
Dictionary<T, double>probabilitiesA dictionary containing the probability of getting each value.

Exceptions

  • ArgumentException: Thrown if the sum of probabilities is not equal to 1.
  • Exception: Thrown if an unexpected error occurs while selecting a random value.

Usage

c#
using PeyrSharp.Core.Maths;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Proba + +

+

+ This page is about the Proba class + available in + PeyrSharp.Core.Maths. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Proba class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ GetRandomValue(probabilities) + +

+

+ Definition + +

+

+ Gets a random value based on the specified + probabilities. Returns a randomly selected value. +

+

+ Type parameters + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
T-The type of the values to select from.
+

+ Parameters + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
Dictionary<T, double>probabilities + A dictionary containing the probability of + getting each value. +
+

+ Exceptions + +

+
    +
  • + ArgumentException: Thrown if the sum of + probabilities is not equal to 1. +
  • +
  • + Exception: Thrown if an unexpected + error occurs while selecting a random value. +
  • +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 Dictionary<string, double> probabilities = new Dictionary<string, double>
 {
@@ -24,9 +1706,102 @@
 };
 
 string result = Proba.GetRandomValue(probabilities);
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/stats.html b/docs/core/maths/stats.html index 41313a1..83d2ff9 100644 --- a/docs/core/maths/stats.html +++ b/docs/core/maths/stats.html @@ -1,38 +1,1961 @@ - - + + Stats | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Stats

This page is about the Stats class available in PeyrSharp.Core.Maths. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Stats class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

Mean(values)

Definition

Returns the mean of a dataset as a double.

Arguments

TypeNameMeaning
List<double>valuesThe dataset to calculate.

Exceptions

TypeMeaning
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Core.Maths;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Stats + +

+

+ This page is about the Stats class + available in + PeyrSharp.Core.Maths. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Stats class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ Mean(values) + +

+

+ Definition + +

+

+ Returns the mean of a dataset as a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
List<double>valuesThe dataset to calculate.
+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeMeaning
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 List<double> dataset = new List<double> { 1, 2, 3, 4, 5 };
 double mean = Stats.Mean(dataset); // Calculate the mean of the dataset
 // mean = 3
-

Median(values)

Definition

Returns the median of a dataset as a double.

Arguments

TypeNameMeaning
List<double>valuesThe dataset to calculate.

Exceptions

TypeMeaning
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ Median(values) + +

+

+ Definition + +

+

+ Returns the median of a dataset as a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
List<double>valuesThe dataset to calculate.
+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeMeaning
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 List<double> dataset = new List<double> { 1, 2, 3, 4, 5 };
 double median = Stats.Median(dataset); // Calculate the median of the dataset
 // median = 3
-

Mode(values)

Definition

Returns the mode of a dataset as a double.

Arguments

TypeNameMeaning
List<double>valuesThe dataset to calculate.

Exceptions

TypeMeaning
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ Mode(values) + +

+

+ Definition + +

+

+ Returns the mode of a dataset as a + double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
List<double>valuesThe dataset to calculate.
+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeMeaning
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 
 List<double> dataset = new List<double> { 1, 2, 3, 3, 3, 4, 5 };
 double mode = Stats.Mode(dataset); // Calculate the mode of the dataset
 // mode = 3
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/maths/trigonometry.html b/docs/core/maths/trigonometry.html index c2abb89..3ad5e1e 100644 --- a/docs/core/maths/trigonometry.html +++ b/docs/core/maths/trigonometry.html @@ -1,38 +1,1970 @@ - - + + Trigonometry | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Trigonometry

This page is about the Trigonometry class available in PeyrSharp.Core.Maths. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Trigonometry class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

GetOpposedSideFrom(triangleSide, angle, value)

Definition

Gets the length of the opposed side of a specific angle, from the length of either the hypotenuse or the adjacent side of the angle.

Arguments

TypeNameMeaning
TriangleSidestriangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.

WARNING

If triangleSide is equal to TriangleSides.Opposed, an Exception will be thrown.

Usage

c#
using PeyrSharp.Core.Maths;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Trigonometry + +

+

+ This page is about the Trigonometry class + available in + PeyrSharp.Core.Maths. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Trigonometry class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ GetOpposedSideFrom(triangleSide, angle, value) + +

+

+ Definition + +

+

+ Gets the length of the opposed side of a specific + angle, from the length of either the hypotenuse or the + adjacent side of the angle. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
+ TriangleSides + triangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.
+
+

WARNING

+

+ If triangleSide is equal to + TriangleSides.Opposed, an + Exception will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 using PeyrSharp.Enums;
 
 double opposed = Trigonometry.GetOpposedSideFrom(TriangleSides.Adjacent, 1.05, 5);
 // opposed = 8.716576549915851
-

GetAdjacentSideFrom(triangleSide, angle, value)

Definition

Gets the length of the adjacent side of a specific angle, from the length of either the hypotenuse or the opposed side of the angle.

Arguments

TypeNameMeaning
TriangleSidestriangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.

WARNING

If triangleSide is equal to TriangleSides.Adjacent, an Exception will be thrown.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ GetAdjacentSideFrom(triangleSide, angle, value) + +

+

+ Definition + +

+

+ Gets the length of the adjacent side of a specific + angle, from the length of either the hypotenuse or the + opposed side of the angle. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
+ TriangleSides + triangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.
+
+

WARNING

+

+ If triangleSide is equal to + TriangleSides.Adjacent, an + Exception will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 using PeyrSharp.Enums;
 
 double adjacent = Trigonometry.GetAdjacentSideFrom(TriangleSides.Opposed, 1.05, 8.71);
 // adjacent = 4.996227561429541
-

GetHypotenuseFrom(triangleSide, angle, value)

Definition

Gets the length of the hypotenuse, from the length of either the adjacent side or the opposed side of a specific angle.

Arguments

TypeNameMeaning
TriangleSidestriangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.

WARNING

If triangleSide is equal to TriangleSides.Hypotenuse, an Exception will be thrown.

Usage

c#
using PeyrSharp.Core.Maths;
+
+
+

+ GetHypotenuseFrom(triangleSide, angle, value) + +

+

+ Definition + +

+

+ Gets the length of the hypotenuse, from the length of + either the adjacent side or the opposed side of a + specific angle. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
+ TriangleSides + triangleSideThe side of the triangle.
doubleangleThe value of the angle.
doublevalueThe length of the chosen side.
+
+

WARNING

+

+ If triangleSide is equal to + TriangleSides.Hypotenuse, an + Exception will be thrown. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Maths;
 using PeyrSharp.Enums;
 
 double hypotenuse = Trigonometry.GetHypotenuseFrom(TriangleSides.Opposed, 1.05, 8.71);
 // hypotenuse = 10.041234478169912
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/core/password.html b/docs/core/password.html index cff27bf..1dcc8ab 100644 --- a/docs/core/password.html +++ b/docs/core/password.html @@ -1,28 +1,1763 @@ - - + + Password | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Password

This page is about the Password class available in PeyrSharp.Core. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Password class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core

Methods

GenerateAsync(length, chars, separator)

Definition

The GenerateAsync() method generates a password of a specific length, with specific characters asynchronously.

Arguments

TypeNameMeaning
intlengthThe length of the password.
stringcharactersThe characters that can be included in the password. Separated with a unique separator.
stringseparatorThe separator used to separate the specified characters.

Usage

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Password + +

+

+ This page is about the Password class + available in PeyrSharp.Core. You can find here all of + its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Password class is part of the + PeyrSharp.Core module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Framework.NET 5.NET 6.NET 7
Core
+

+ Methods + +

+

+ GenerateAsync(length, chars, separator) + +

+

+ Definition + +

+

+ The GenerateAsync() method generates a + password of a specific length, with specific + characters asynchronously. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
intlengthThe length of the password.
stringcharacters + The characters that can be included in the + password. Separated with a unique separator. +
stringseparator + The separator used to separate the specified + characters. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 private async void Main()
 {
     // Generate a password with 10 characters
     string password = await Password.GenerateAsync(10, "a,b,c,d,e,f,1,2,3,4,5", ",");
 }
-

GenerateAsync(length, passwordPresets)

Definition

The GenerateAsync() method generates a password of a specific length, with a specific PasswordPresets asynchronously.

Arguments

TypeNameMeaning
intlengthThe length of the password.
PasswordPresetspasswordPresetsThe password preset used when generating the password

Usage

c#
using PeyrSharp.Core;
+
+
+

+ GenerateAsync(length, passwordPresets) + +

+

+ Definition + +

+

+ The GenerateAsync() method generates a + password of a specific length, with a specific + PasswordPresets + asynchronously. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
intlengthThe length of the password.
+ PasswordPresets + passwordPresets + The password preset used when generating the + password +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 using PeyrSharp.Enums;
 
 private async void Main()
@@ -30,7 +1765,95 @@
     // Generate a password with 10 characters, using the Complex preset
     string password = await Password.GenerateAsync(10, PasswordPresets.Complex);
 }
-

GenerateAsync(amount, length, chars, separator)

Definition

The GenerateAsync() method generates a specific amount of passwords with specific lengths and characters asynchronously.

Arguments

TypeNameMeaning
intamountThe amount of passwords to generate.
intlengthThe length of the password.
stringcharactersThe characters that can be included in the password. Separated with a unique separator.
stringseparatorThe separator used to separate the specified characters.

Usage

c#
using System.Collections.Generic;
+
+
+

+ GenerateAsync(amount, length, chars, separator) + +

+

+ Definition + +

+

+ The GenerateAsync() method generates a + specific amount of passwords with specific lengths and + characters asynchronously. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
intamountThe amount of passwords to generate.
intlengthThe length of the password.
stringcharacters + The characters that can be included in the + password. Separated with a unique separator. +
stringseparator + The separator used to separate the specified + characters. +
+

+ Usage + +

+
+ c# +
using System.Collections.Generic;
 using PeyrSharp.Core;
 
 private async void Main()
@@ -38,7 +1861,94 @@
     // Generate 10 passwords with 10 characters
     List<string> passwords = await Password.GenerateAsync(10, 10, "a,b,c,d,e,f,1,2,3,4,5", ",");
 }
-

GenerateAsync(amount, length, passwordPresets)

Definition

The GenerateAsync() method generates a specific amount of passwords with specific lengths and PasswordPresets asynchronously.

Arguments

TypeNameMeaning
intamountThe amount of passwords to generate.
intlengthThe length of the password.
PasswordPresetspasswordPresetsThe password preset used when generating the password

Usage

c#
using System.Collections.Generic;
+
+
+

+ GenerateAsync(amount, length, passwordPresets) + +

+

+ Definition + +

+

+ The GenerateAsync() method generates a + specific amount of passwords with specific lengths and + PasswordPresets + asynchronously. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
intamountThe amount of passwords to generate.
intlengthThe length of the password.
+ PasswordPresets + passwordPresets + The password preset used when generating the + password +
+

+ Usage + +

+
+ c# +
using System.Collections.Generic;
 using PeyrSharp.Core;
 using PeyrSharp.Enums;
 
@@ -47,9 +1957,94 @@
     // Generate 10 passwords with 10 characters with the simple preset
     List<string> passwords = await Password.GenerateAsync(10, 10, PasswordPresets.Simple);
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/enumerations.html b/docs/enumerations.html index e2a6a94..91e8eb5 100644 --- a/docs/enumerations.html +++ b/docs/enumerations.html @@ -1,35 +1,2399 @@ - - + + Enumerations | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Enumerations

This page is about the enumerations available in PeyrSharp.Enums. They are grouped by category.

Compatibility

Enumerations are part of the PeyrSharp.Enums module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Enums
Framework.NET 5.NET 6.NET 7
Enums

Converters

StorageUnits

Definition

The StorageUnits enumeration represents all possible numeric storage units. It contains the following values:

ValueNameMeaning
0ByteThe byte unit. (b)
1KilobyteThe kilobyte unit. (kb)
2MegabyteThe megabyte unit. (mb)
3GigabyteThe gigabyte unit. (gb)
4TerabyteThe terabyte unit. (tb)
5PetabyteThe petabyte unit. (pb)

Example

c#
public static double ToPetabyte(double value, StorageUnits unit)
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Enumerations + +

+

+ This page is about the enumerations available in + PeyrSharp.Enums. They are grouped by category. +

+

+ Compatibility + +

+

+ Enumerations are part of the + PeyrSharp.Enums module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Enums
Framework.NET 5.NET 6.NET 7
Enums
+

+ Converters + +

+

+ StorageUnits + +

+

+ Definition + +

+

+ The StorageUnits enumeration represents + all possible numeric storage units. It contains the + following values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0ByteThe byte unit. (b)
1KilobyteThe kilobyte unit. (kb)
2MegabyteThe megabyte unit. (mb)
3GigabyteThe gigabyte unit. (gb)
4TerabyteThe terabyte unit. (tb)
5PetabyteThe petabyte unit. (pb)
+

+ Example + +

+
+ c# +
public static double ToPetabyte(double value, StorageUnits unit)
 {
     if (unit == StorageUnits.Terabyte)
     {
         return value / 1000d;
     }
 }
-

TimeUnits

Definition

The TimeUnits enumeration represents all possible time units, such as seconds, minutes, etc. A more detailed table on all the values available:

ValueNameMeaning
0MillisecondsRepresents milliseconds.
1SecondsRepresents seconds.
2MinutesRepresents minutes.
3HoursRepresents hours.
4DaysRepresents days.

Example

c#
public static double ToSeconds(double value, TimeUnits unit)
+
+
+

+ TimeUnits + +

+

+ Definition + +

+

+ The TimeUnits enumeration represents all + possible time units, such as seconds, minutes, etc. A + more detailed table on all the values available: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0MillisecondsRepresents milliseconds.
1SecondsRepresents seconds.
2MinutesRepresents minutes.
3HoursRepresents hours.
4DaysRepresents days.
+

+ Example + +

+
+ c# +
public static double ToSeconds(double value, TimeUnits unit)
 {
     if (unit == TimeUnits.Minutes)
     {
         return value * 60;
     }
 }
-

Environment

LogLevel

Definition

The LogLevel enumeration specifies the severity level of a log message. It contains several values:

ValueNameMeaning
0DebugDebug-level messages provide verbose information for debugging purposes.
1InfoInfo-level messages provide informational messages about the application's state.
2WarningWarning-level messages indicate a potential problem or non-critical issue.
3ErrorError-level messages indicate an error has occurred in the application.
4CriticalCritical-level messages indicate a critical error has occurred that requires immediate attention.
5MiscMisc-level messages are for miscellaneous use cases and are not defined in the logging specification.

Example

c#
using PeyrSharp.Enums;
+
+
+

+ Environment + +

+

+ LogLevel + +

+

+ Definition + +

+

+ The LogLevel enumeration specifies the + severity level of a log message. It contains several + values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Debug + Debug-level messages provide verbose information + for debugging purposes. +
1Info + Info-level messages provide informational + messages about the application's state. +
2Warning + Warning-level messages indicate a potential + problem or non-critical issue. +
3Error + Error-level messages indicate an error has + occurred in the application. +
4Critical + Critical-level messages indicate a critical + error has occurred that requires immediate + attention. +
5Misc + Misc-level messages are for miscellaneous use + cases and are not defined in the logging + specification. +
+

+ Example + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 string message = "This is a log message.";
@@ -38,18 +2402,407 @@
 LogLevel logLevel = LogLevel.Warning;
 
 Logger.Log(message, filePath, date, logLevel);
-

More info here about the example

OperatingSystems

Definition

The OperatingSystems enumerations represents all possible operating systems that a .NET program could run on. It contains several values:

ValueNameMeaning
0WindowsThe Microsoft Windows Operating System.
1macOSThe Apple macOS Operating System.
2LinuxA Linux-based Operating System.
3UnknownAn unknown Operating System.

Example

c#
if (Env.CurrentOs == OperatingSystems.Windows)
+
+
+

+ More info here about the example +

+

+ OperatingSystems + +

+

+ Definition + +

+

+ The OperatingSystems enumerations + represents all possible operating systems that a .NET + program could run on. It contains several values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0WindowsThe Microsoft Windows Operating System.
1macOSThe Apple macOS Operating System.
2LinuxA Linux-based Operating System.
3UnknownAn unknown Operating System.
+

+ Example + +

+
+ c# +
if (Env.CurrentOs == OperatingSystems.Windows)
 {
     //Do something if the OS is Windows
 }
-

SystemThemes

Definition

The SystemThemes enumerations represents all themes available on a Windows device. It contains several values:

ValueNameMeaning
0DarkThe user is using dark theme.
1LightThe user is using light theme.
2UnknownThe current theme is unknown.

Example

c#
if (GetCurrentTheme() == SystemThemes.Dark)
+
+
+

+ SystemThemes + +

+

+ Definition + +

+

+ The SystemThemes enumerations represents + all themes available on a Windows device. It contains + several values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0DarkThe user is using dark theme.
1LightThe user is using light theme.
2UnknownThe current theme is unknown.
+

+ Example + +

+
+ c# +
if (GetCurrentTheme() == SystemThemes.Dark)
 {
     Console.WriteLine("You have dark theme enabled!");
 }
-

WindowsVersion

Definition

The WindowsVersion enumerations represents all possible Windows versions supported by .NET, which means all version from Windows 7 to 11. It contains several values:

ValueNameMeaning
0Windows7The Windows 7 (NT 6.1) Operating System.
1Windows8The Windows 8 (NT 6.2) Operating System.
2Windows81The Windows 8.1 (NT 6.3) Operating System.
3Windows10The Windows 10 (NT 10.0) Operating System.
4Windows11The Windows 11 (NT 10.0, Build 22000+) Operating System.

Example

c#
public bool DarkThemeAvailable => Env.CurrentWindowsVersion == WindowsVersion.Windows10 || Env.CurrentWindowsVersion == WindowsVersion.Windows11;
-

Geometry

TriangleSides

Definition

The TriangleSides enumeration represents the different sides of a triangle: hypotenuse, adjacent, and opposite. It contains these values:

ValueNameMeaning
0OpposedThe opposed side of a specific angle of a triangle.
1HypotenuseThe hypotenuse of a triangle.
2AdjacentThe adjacent side of a specific angle of a triangle.

Example

c#
// Get the adjacent side from the opposed side of a specific angle.
+
+
+

+ WindowsVersion + +

+

+ Definition + +

+

+ The WindowsVersion enumerations + represents all possible Windows versions supported by + .NET, which means all version from Windows 7 to 11. It + contains several values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Windows7The Windows 7 (NT 6.1) Operating System.
1Windows8The Windows 8 (NT 6.2) Operating System.
2Windows81 + The Windows 8.1 (NT 6.3) Operating System. +
3Windows10 + The Windows 10 (NT 10.0) Operating System. +
4Windows11 + The Windows 11 (NT 10.0, Build 22000+) Operating + System. +
+

+ Example + +

+
+ c# +
public bool DarkThemeAvailable => Env.CurrentWindowsVersion == WindowsVersion.Windows10 || Env.CurrentWindowsVersion == WindowsVersion.Windows11;
+
+
+

+ Geometry + +

+

+ TriangleSides + +

+

+ Definition + +

+

+ The TriangleSides enumeration represents + the different sides of a triangle: hypotenuse, + adjacent, and opposite. It contains these values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Opposed + The opposed side of a specific angle of a + triangle. +
1HypotenuseThe hypotenuse of a triangle.
2Adjacent + The adjacent side of a specific angle of a + triangle. +
+

+ Example + +

+
+ c# +
// Get the adjacent side from the opposed side of a specific angle.
 Trigonometry.GetAdjacentSideFrom(TriangleSides.Opposed, 20);
-

Internet

StatusCodes

Definition

The StatusCodes enumeration represents the different kinds of status codes returned by a server after a request is made to it. The following status codes are available in this enumeration:

ValueNameMeaning
0InformationalInformational responses (100-199)
1SuccessSuccessful responses (200-299)
2RedirectionRedirection messages (300-399)
3ClientErrorClient error responses (400-499)
4ServerErrorServer error responses (500-599)

Example

c#
status = GetRequestStatus();
+
+
+

+ Internet + +

+

+ StatusCodes + +

+

+ Definition + +

+

+ The StatusCodes enumeration represents + the different kinds of status codes returned by a + server after a request is made to it. The following + status codes are available in this enumeration: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0InformationalInformational responses (100-199)
1SuccessSuccessful responses (200-299)
2RedirectionRedirection messages (300-399)
3ClientErrorClient error responses (400-499)
4ServerErrorServer error responses (500-599)
+

+ Example + +

+
+ c# +
status = GetRequestStatus();
 
 switch (status)
 {
@@ -69,11 +2822,171 @@
         Console.WriteLine("An server error status code has been returned.");
         break;
 }
-

Password

PasswordPresets

Definition

The PasswordPresets enumeration represents all the of the presets available when generating a password using the Password class of PeyrSharp.Core. It has two values:

ValueNameMeaning
0SimpleThe Simple preset generates a password with simple characters.
1ComplexThe Complex preset generates a password with unusual, hard and complex characters.

Example

c#
private async void Main()
+
+
+

+ Password + +

+

+ PasswordPresets + +

+

+ Definition + +

+

+ The PasswordPresets enumeration + represents all the of the presets available when + generating a password using the + Password class of + PeyrSharp.Core. It has two values: +

+ + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Simple + The Simple preset generates a password with + simple characters. +
1Complex + The Complex preset generates a password with + unusual, hard and complex characters. +
+

+ Example + +

+
+ c# +
private async void Main()
 {
     string password = Password.GenerateAsync(10, PasswordPresets.Simple); // Generate a simple password
 }
-

PasswordStrength

Definition

The PasswordStrength enumeration represents different strength levels of a password; if it's a strong or weak password. It contains these values:

ValueNameMeaning
0LowThe password has a low strength; you shouldn't use it.
1MediumThe password has a medium strength; don't use it on important websites.
2GoodThe password has a good strength; you can safely use it.
3VeryGoodThe password has an excellent strength, meaning it will be hard for hackers to hack it.

Example

c#
internal async void Main()
+
+
+

+ PasswordStrength + +

+

+ Definition + +

+

+ The PasswordStrength enumeration + represents different strength levels of a password; if + it's a strong or weak password. It contains these + values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Low + The password has a low strength; you + shouldn't use it. +
1Medium + The password has a medium strength; don't + use it on important websites. +
2Good + The password has a good strength; you can safely + use it. +
3VeryGood + The password has an excellent strength, meaning + it will be hard for hackers to hack it. +
+

+ Example + +

+
+ c# +
internal async void Main()
 {
     // Check if the generated password is complex
     if (Password.GetStrength(await Password.GenerateAsync(15, PasswordPresets.Complex)) == PasswordStrength.Medium)
@@ -81,7 +2994,90 @@
         Console.WriteLine("The password isn't complex enough.");
     }
 }
-

UserInterface

ControlAlignment

Definition

The ControlAlignment enumeration is here to help align a control when calling methods from the UiHelpers namespace. It has the following values:

ValueNameMeaning
0HorizontalThe control will be aligned/centered horizontally.
1VerticalThe control will be aligned/centered vertically.
2BothThe control will be aligned/centered horizontally and vertically.

Example

c#
using PeyrSharp.UiHelpers;
+
+
+

+ UserInterface + +

+

+ ControlAlignment + +

+

+ Definition + +

+

+ The ControlAlignment enumeration is here + to help align a control when calling methods from the + UiHelpers namespace. It has the following + values: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ValueNameMeaning
0Horizontal + The control will be aligned/centered + horizontally. +
1Vertical + The control will be aligned/centered vertically. +
2Both + The control will be aligned/centered + horizontally and vertically. +
+

+ Example + +

+
+ c# +
using PeyrSharp.UiHelpers;
 
 namespace App
 {
@@ -93,9 +3089,100 @@
         }
     }
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/env.html b/docs/env.html index 507fd1c..ffc12f8 100644 --- a/docs/env.html +++ b/docs/env.html @@ -1,23 +1,865 @@ - - + + Env | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Env

This page is about the PeyrSharp.Env module.

Compatibility

The PeyrSharp.Env module is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env⚠️⚠️
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Env + +

+

This page is about the PeyrSharp.Env module.

+

+ Compatibility + +

+

+ The PeyrSharp.Env module is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Env⚠️⚠️
Framework.NET 5.NET 6.NET 7
Env
+
+

WARNING

+

+ Some methods, classes or features of + PeyrSharp.Env might not be available in + all platforms. +

+
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/env/filesys.html b/docs/env/filesys.html index 529cff3..ed58d88 100644 --- a/docs/env/filesys.html +++ b/docs/env/filesys.html @@ -1,45 +1,1306 @@ - - + + FileSys | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

FileSys

This page is about the FileSys class available in PeyrSharp.Env. You can find here all of its methods and properties.

INFO

This class is static.

Compatibility

The FileSys class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

GetAvailableSpace(drive, unit)

Definition

Gets the amount of available storage on a specified drive. It returns double.

Arguments

TypeNameMeaning
stringdriveThe drive letter or name to get the amount of available space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ FileSys + +

+

+ This page is about the FileSys class + available in + PeyrSharp.Env. You can find here all of its methods and + properties. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The FileSys class is part of the + PeyrSharp.Env module, and is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env
+
+

WARNING

+

+ Some methods, classes or features of + PeyrSharp.Env might not be available in + all platforms. +

+
+

+ Methods + +

+

+ GetAvailableSpace(drive, unit) + +

+

+ Definition + +

+

+ Gets the amount of available storage on a specified + drive. It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringdrive + The drive letter or name to get the amount of + available space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double space = FileSys.GetAvailableSpace("C:/", StorageUnits.Gigabyte);
-

GetAvailableSpace(driveInfo, unit)

Definition

Gets the amount of available storage on a specified drive. It returns double.

Arguments

TypeNameMeaning
DriveInfodriveInfoThe DriveInfo object to get the amount of available space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ GetAvailableSpace(driveInfo, unit) + +

+

+ Definition + +

+

+ Gets the amount of available storage on a specified + drive. It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
DriveInfodriveInfo + The DriveInfo object to get the + amount of available space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double space = FileSys.GetAvailableSpace(new DriveInfo("C:/"), StorageUnits.Gigabyte);
-

GetOccupiedSpace(drive, unit)

Definition

Gets the amount of occupied storage on a specified drive. It returns double.

Arguments

TypeNameMeaning
stringdriveThe drive letter or name to get the amount of occupied space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ GetOccupiedSpace(drive, unit) + +

+

+ Definition + +

+

+ Gets the amount of occupied storage on a specified + drive. It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringdrive + The drive letter or name to get the amount of + occupied space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double occupiedSpace = FileSys.GetOccupiedSpace("C:/", StorageUnits.Gigabyte);
-

GetOccupiedSpace(driveInfo, unit)

Definition

Gets the amount of occupied storage on a specified drive. It returns double.

Arguments

TypeNameMeaning
DriveInfodriveInfoThe DriveInfo object to get the amount of occupied space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ GetOccupiedSpace(driveInfo, unit) + +

+

+ Definition + +

+

+ Gets the amount of occupied storage on a specified + drive. It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
DriveInfodriveInfo + The DriveInfo object to get the + amount of occupied space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double occupiedSpace = FileSys.GetOccupiedSpace(new DriveInfo("C:/"), StorageUnits.Gigabyte);
-

GetTotalSpace(drive, unit)

Definition

Gets the total amount of space on a specified drive. It returns double.

Arguments

TypeNameMeaning
stringdriveThe drive letter or name to get the amount of total space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ GetTotalSpace(drive, unit) + +

+

+ Definition + +

+

+ Gets the total amount of space on a specified drive. + It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringdrive + The drive letter or name to get the amount of + total space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double occupiedSpace = FileSys.GetTotalSpace("C:/", StorageUnits.Gigabyte);
-

GetTotalSpace(driveInfo, unit)

Definition

Gets the total amount of space on a specified drive. It returns double.

Arguments

TypeNameMeaning
DriveInfodriveInfoThe DriveInfo object to get the amount of total space.
StorageUnitsunitThe unit of the returned result.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ GetTotalSpace(driveInfo, unit) + +

+

+ Definition + +

+

+ Gets the total amount of space on a specified drive. + It returns double. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
DriveInfodriveInfo + The DriveInfo object to get the + amount of total space. +
StorageUnitsunitThe unit of the returned result.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 double total = FileSys.GetTotalSpace(new DriveInfo("C:/"), StorageUnits.Gigabyte);
-

CountFileCharactersAsync(fileName)

Definition

Counts the number of characters in specified file asynchronously. It returns an int.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringfileNameThe file path of the file.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ CountFileCharactersAsync(fileName) + +

+

+ Definition + +

+

+ Counts the number of characters in specified file + asynchronously. It returns an int. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringfileNameThe file path of the file.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 public static async Task ExampleAsync()
 {
@@ -52,7 +1313,72 @@
 
     // chars = 13
 }
-

CanWriteFile(filePath)

Definition

Checks if your program has the permission to write a file in a specific directory. It returns a bool; true if you can write/edit the specified directory.

Arguments

TypeNameMeaning
stringfilePathThe path to the directory.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ CanWriteFile(filePath) + +

+

+ Definition + +

+

+ Checks if your program has the permission to write a + file in a specific directory. It returns a + bool; true if you can + write/edit the specified directory. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringfilePathThe path to the directory.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 if (FileSys.CanWriteFile(@"C:\Windows"))
 {
@@ -62,13 +1388,146 @@
 {
     Console.WriteLine("You do not have permission to edit in this folder.");
 }
-

IsDriveOpticalDrive(driveInfo)

Available in version 1.1 and higher.

Definition

Checks if the specified drive is an optical drive, such as CD-ROM or DVD. It returns a bool; true if the drive is an optical drive.

Arguments

TypeNameMeaning
stringdriveInfoThe drive to check.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ IsDriveOpticalDrive(driveInfo) + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+

+ Checks if the specified drive is an optical drive, + such as CD-ROM or DVD. It returns a bool; + true if the drive is an optical drive. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringdriveInfoThe drive to check.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 if (FileSys.IsOpticalDrive(new(@"E:\")))
 {
     Console.WriteLine("Drive E:/ is an optical drive")
 }
-

GetDriveStorageUnit(driveInfo)

Available in version 1.1 and higher.

Definition

Gets the appropriate StorageUnits to use depending of the total size of the drive. It returns a StorageUnits value.

Arguments

TypeNameMeaning
stringdriveInfoThe drive to get the unit of.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ GetDriveStorageUnit(driveInfo) + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+

+ Gets the appropriate + StorageUnits + to use depending of the total size of the drive. It + returns a StorageUnits value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringdriveInfoThe drive to get the unit of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 var unit = FileSys.GetDriveStorageUnit(@"C:\");
 
@@ -81,38 +1540,457 @@
 }
 
 Console.WriteLine(message);
-

Properties

AppDataPath

Definition

c#
public static string AppDataPath { get; }
-

The AppDataPath property gets the %APPDATA% path. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ Properties + +

+

+ AppDataPath + +

+

+ Definition + +

+
+ c# +
public static string AppDataPath { get; }
+
+
+

+ The AppDataPath property gets the + %APPDATA% path. You can only + get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string appdata = FileSys.AppDataPath;
-

CurrentAppDirectory

Available in version 1.1 and higher.

Definition

c#
public static string CurrentAppDirectory { get; }
-

The CurrentAppDirectory property gets the path where is located the executable file that is currently running. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ CurrentAppDirectory + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+
+ c# +
public static string CurrentAppDirectory { get; }
+
+
+

+ The CurrentAppDirectory property gets the + path where is located the executable file that is + currently running. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string dir = FileSys.CurrentAppDirectory;
-

DriveWithHighestFreeSpace

Available in version 1.1 and higher.

Definition

c#
public static DriveInfo DriveWithHighestFreeSpace { get; }
-

The DriveWithHighestFreeSpace property gets the drive with the highest free space available. You can only get this property.

Usage

c#
using System.IO;
+
+
+

+ DriveWithHighestFreeSpace + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+
+ c# +
public static DriveInfo DriveWithHighestFreeSpace { get; }
+
+
+

+ The DriveWithHighestFreeSpace property + gets the drive with the highest free space available. + You can only get this property. +

+

+ Usage + +

+
+ c# +
using System.IO;
 using PeyrSharp.Env;
 
 DriveInfo highest = FileSys.DriveWithHighestFreeSpace;
-

DriveWithLowestFreeSpace

Available in version 1.1 and higher.

Definition

c#
public static DriveInfo DriveWithLowestFreeSpace { get; }
-

The DriveWithLowestFreeSpace property gets the drive with the lowest free space available. You can only get this property.

Usage

c#
using System.IO;
+
+
+

+ DriveWithLowestFreeSpace + +

+

Available in version 1.1 and higher.

+

+ Definition + +

+
+ c# +
public static DriveInfo DriveWithLowestFreeSpace { get; }
+
+
+

+ The DriveWithLowestFreeSpace property + gets the drive with the lowest free space available. + You can only get this property. +

+

+ Usage + +

+
+ c# +
using System.IO;
 using PeyrSharp.Env;
 
 DriveInfo lowest = FileSys.DriveWithLowestFreeSpace;
-

SystemDrive

Definition

c#
[SupportedOSPlatform("windows")]
+
+
+

+ SystemDrive + +

+

+ Definition + +

+
+ c# +
[SupportedOSPlatform("windows")]
 public static DriveInfo SystemDrive { get; }
-

The SystemDrive property gets the system drive, where Windows is installed. You can only get this property.

DANGER

This property only works on Windows! It will return a default value if you run it on a different platform.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ The SystemDrive property gets the system + drive, where Windows is installed. You can only + get this property. +

+
+

DANGER

+

+ This property only works on Windows! It will return + a default value if you run it on a different + platform. +

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 DriveInfo sys = FileSys.SystemDrive;
-

CurrentDirectory

Definition

Gets the current directory of the application. Returns a string representing the full path of the current directory.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ CurrentDirectory + +

+

+ Definition + +

+

+ Gets the current directory of the application. Returns + a string representing the full path of the current + directory. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string currentDirectory = FileSys.CurrentDirectory;
-

ComputerName

Definition

Returns the name of the current computer as a string.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ ComputerName + +

+

+ Definition + +

+

+ Returns the name of the current computer as a + string. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string computerName = FileSys.ComputerName;
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/env/logger.html b/docs/env/logger.html index 4acda19..dc25050 100644 --- a/docs/env/logger.html +++ b/docs/env/logger.html @@ -1,33 +1,1056 @@ - - + + Logger | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Logger

This page is about the Logger class available in PeyrSharp.Env. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Logger class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

Log(message, filePath, dateTime)

Definition

The Log() method logs a specific message alongside a timestamp into a file. This method does not return a value (void).

INFO

You can call this method multiple times on the same file and it will append the message to it.

Arguments

TypeNameMeaning
stringmessageThe message or text that needs to be logged.
stringfilePathThe path where the file should be written.
DateTimedateTimeThe timestamp of the log, the time when the log was made.

Usage

c#
using PeyrSharp.Env;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Logger + +

+

+ This page is about the Logger class + available in + PeyrSharp.Env. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Logger class is part of the + PeyrSharp.Env module, and is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env
+
+

WARNING

+

+ Some methods, classes or features of + PeyrSharp.Env might not be available in + all platforms. +

+
+

+ Methods + +

+

+ Log(message, filePath, dateTime) + +

+

+ Definition + +

+

+ The Log() method logs a specific message + alongside a timestamp into a file. This method does + not return a value (void). +

+
+

INFO

+

+ You can call this method multiple times on the same + file and it will append the message to it. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringmessage + The message or text that needs to be logged. +
stringfilePath + The path where the file should be written. +
DateTimedateTime + The timestamp of the log, the time when the log + was made. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 Logger.Log("Hello", @"C:\Logs\log1.txt", DateTime.Now)
 // The line above will generate a file with the following content:
 // [10/31/2022 09:23:18] Hello
-

Log(message, filePath, formatString)

Definition

Logs a formatted message to a file. This method does not return a value.

Arguments

TypeNameMeaning
stringmessageThe log message to be written.
stringfilePathThe path to the log file. Must contain an extension.
object[]formatStringAn object array that contains zero or more objects to format.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ Log(message, filePath, formatString) + +

+

+ Definition + +

+

+ Logs a formatted message to a file. This method does + not return a value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringmessageThe log message to be written.
stringfilePath + The path to the log file. Must contain an + extension. +
object[]formatString + An object array that contains zero or more + objects to format. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string message = "This is a log message. Date: {0}.";
 string filePath = @"C:\Logs\log.txt";
 DateTime date = DateTime.Now;
 
 Logger.Log(message, filePath, date);
-

Log(message, filePath, dateTime, logLevel)

Definition

Logs a message with the specified severity level, file path, and timestamp. This method does not return a value.

Arguments

TypeNameMeaning
stringmessageThe message to log.
stringfilePathThe path to the file where the message was logged.
DateTimedateTimeThe timestamp for the log message.
LogLevellogLevelThe severity level for the log message.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ Log(message, filePath, dateTime, logLevel) + +

+

+ Definition + +

+

+ Logs a message with the specified severity level, file + path, and timestamp. This method does not return a + value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringmessageThe message to log.
stringfilePath + The path to the file where the message was + logged. +
DateTimedateTimeThe timestamp for the log message.
+ LogLevel + logLevelThe severity level for the log message.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Env;
 
 string message = "This is a log message.";
@@ -36,9 +1059,100 @@
 LogLevel logLevel = LogLevel.Warning;
 
 Logger.Log(message, filePath, date, logLevel);
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/env/system.html b/docs/env/system.html index a78f893..de891ef 100644 --- a/docs/env/system.html +++ b/docs/env/system.html @@ -1,52 +1,1289 @@ - - + + Sys | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Sys

This page is about the Sys class available in PeyrSharp.Env. You can find here all of its methods and properties.

INFO

This class is static.

Compatibility

The Sys class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env⚠️⚠️
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

ExecuteAsAdmin(process)

Definition

Executes a program in administrator mode.

WARNING

This method only works on Windows.

Arguments

TypeNameMeaning
ProcessprocessThe process to launch as admin.

Usage

c#
using PeyrSharp.Env;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Sys + +

+

+ This page is about the Sys class + available in + PeyrSharp.Env. You can find here all of its methods and + properties. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Sys class is part of the + PeyrSharp.Env module, and is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Env⚠️⚠️
Framework.NET 5.NET 6.NET 7
Env
+
+

WARNING

+

+ Some methods, classes or features of + PeyrSharp.Env might not be available in + all platforms. +

+
+

+ Methods + +

+

+ ExecuteAsAdmin(process) + +

+

+ Definition + +

+

Executes a program in administrator mode.

+
+

WARNING

+

This method only works on Windows.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
ProcessprocessThe process to launch as admin.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 // Define a process
 Process p = new();
 p.StartInfo.FileName = "notepad.exe";
 
 Sys.ExecuteAsAdmin(p);
-

ExecuteAsAdmin(fileName)

Definition

Executes a program in administrator mode.

WARNING

This method only works on Windows.

Arguments

TypeNameMeaning
stringfileNameThe path to the program to launch in admin mode.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ ExecuteAsAdmin(fileName) + +

+

+ Definition + +

+

Executes a program in administrator mode.

+
+

WARNING

+

This method only works on Windows.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringfileName + The path to the program to launch in admin mode. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 Sys.ExecuteAsAdmin("notepad.exe");
-

LaunchUWPApp(packageFamilyName, applicationID)

Definition

This method allows you to launch an UWP app from its PackageFamilyName and its Application Id. You can find this information by running in Windows Powershell (admin) the following command:

powershell
Get-AppxPackage | Select PackageFamilyName, InstallLocation
-

You can find the Application Id in the AppxManifest.xml file in

txt
InstallLocation\AppxManifest.xml
-

WARNING

This method only works on Windows.

Arguments

TypeNameMeaning
stringpackageFamilyNameThe PackageFamilyName property.
stringapplicationIDThe Application Id property in the UWP AppxManifest.xml file.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ LaunchUWPApp(packageFamilyName, applicationID) + +

+

+ Definition + +

+

+ This method allows you to launch an UWP app from its + PackageFamilyName and its + Application Id. You can find this + information by running in Windows Powershell (admin) + the following command: +

+
+ powershell +
Get-AppxPackage | Select PackageFamilyName, InstallLocation
+
+
+

+ You can find the Application Id in the + AppxManifest.xml file in +

+
+ txt +
InstallLocation\AppxManifest.xml
+
+
+
+

WARNING

+

This method only works on Windows.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringpackageFamilyName + The PackageFamilyName property. +
stringapplicationID + The Application Id property in the + UWP AppxManifest.xml file. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 Sys.LaunchUWPApp("Microsoft.MinecraftUWP_8wekyb3d8bbwe", "App"); // Launch Minecraft UWP
-

IsProcessRunning(processName)

Definition

Gets if a specified process name is currently running. Returns a bool value indicating whether the process is running (true) or not running (false).

Arguments

TypeNameMeaning
stringprocessNameThe process name to find.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ IsProcessRunning(processName) + +

+

+ Definition + +

+

+ Gets if a specified process name is currently running. + Returns a bool value indicating whether + the process is running (true) or not + running (false). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringprocessNameThe process name to find.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 bool isNotepadRunning = Sys.IsProcessRunning("notepad");
-

TerminateProcess(processId)

Definition

Terminates a process with the specified process ID. Returns True if the process was successfully terminated, or False if no such process was found or if an error occurred while trying to terminate the process.

Arguments

TypeNameMeaning
intprocessIdThe ID of the process to terminate.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ TerminateProcess(processId) + +

+

+ Definition + +

+

+ Terminates a process with the specified process ID. + Returns True if the process was + successfully terminated, or False if no + such process was found or if an error occurred while + trying to terminate the process. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
intprocessIdThe ID of the process to terminate.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 int processId = 12345;
 
 bool result = Sys.TerminateProcess(processId);
-

Properties

CurrentOperatingSystem

Definition

c#
public static OperatingSystems CurrentOperatingSystem { get; }
-

Gets the current Operating system. Returns a OperatingSystems value. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ Properties + +

+

+ CurrentOperatingSystem + +

+

+ Definition + +

+
+ c# +
public static OperatingSystems CurrentOperatingSystem { get; }
+
+
+

+ Gets the current Operating system. Returns a + OperatingSystems + value. You can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 if (Sys.CurrentOperatingSystem == OperatingSystems.Windows)
 {
     Console.WriteLine("You are on Windows");
 }
-

CurrentWindowsVersion

Definition

c#
public static WindowsVersion CurrentWindowsVersion { get; }
-

Gets the current Windows version. Returns a WindowsVersion value. You can only get this property.

WARNING

This property only works on Windows.

DANGER

This property only works if you specify in the Application Manifest, in the compatibility section, that Windows 8, 8.1 and 10/11 are compatible with the software. Otherwise, it will return Windows8.

xml
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
+
+
+

+ CurrentWindowsVersion + +

+

+ Definition + +

+
+ c# +
public static WindowsVersion CurrentWindowsVersion { get; }
+
+
+

+ Gets the current Windows version. Returns a + WindowsVersion + value. You can only get this property. +

+
+

WARNING

+

This property only works on Windows.

+
+
+

DANGER

+

+ This property only works if you specify in the + Application Manifest, in the compatibility section, + that Windows 8, 8.1 and 10/11 are compatible with + the software. Otherwise, it will return + Windows8. +

+
+
+ xml +
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
     <application>
       <!-- Windows Vista -->
       <!--<supportedOS Id="{e2011457-1546-43c5-a5fe-008deee3d3f0}" />-->
@@ -64,21 +1301,133 @@
       <supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}" />
     </application>
 </compatibility>
-

Usage

c#
using PeyrSharp.Env;
+
+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 if (Sys.CurrentWindowsVersion == WindowsVersion.Windows11)
 {
     Console.WriteLine("You are on Windows 11");
 }
-

IsDarkThemeSupported

Definition

c#
public static bool IsDarkThemeSupported { get; }
-

Gets if the current Windows version supports dark theme. Returns a bool value. You can only get this property.

WARNING

This property only works on Windows.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ IsDarkThemeSupported + +

+

+ Definition + +

+
+ c# +
public static bool IsDarkThemeSupported { get; }
+
+
+

+ Gets if the current Windows version supports dark + theme. Returns a bool value. You can only + get this property. +

+
+

WARNING

+

This property only works on Windows.

+
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 if (Sys.IsDarkThemeSupported)
 {
     Console.WriteLine("You are running Windows 10 or higher.");
 }
-

RunningProcesses

Definition

c#
public static Process[] RunningProcesses { get; }
-

Gets the processes that are currently running. Returns a Process[] array. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ RunningProcesses + +

+

+ Definition + +

+
+ c# +
public static Process[] RunningProcesses { get; }
+
+
+

+ Gets the processes that are currently running. Returns + a Process[] array. You can only + get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 Process[] procs = Sys.RunningProcesses;
 
@@ -86,8 +1435,54 @@
 {
     Console.WriteLine(procs[i].ProcessName); // Print the name of all running processes
 }
-

RunningProcessesNames

Definition

c#
public static string[] RunningProcessesNames { get; }
-

Gets the names of the processes that are currently running. Returns a string[] array. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ RunningProcessesNames + +

+

+ Definition + +

+
+ c# +
public static string[] RunningProcessesNames { get; }
+
+
+

+ Gets the names of the processes that are currently + running. Returns a string[] array. You + can only get this property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 string[] procs = Sys.RunningProcessesNames;
 
@@ -95,13 +1490,150 @@
 {
     Console.WriteLine(procs[i]); // Print the name of all running processes
 }
-

UnixTime

Definition

c#
public static int Unix { get; }
-

Gets the current UnixTime. Returns an int. You can only get this property.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ UnixTime + +

+

+ Definition + +

+
+ c# +
public static int Unix { get; }
+
+
+

+ Gets the current UnixTime. Returns an + int. You can only get this + property. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 int unixTime = Sys.UnixTime;
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/env/update.html b/docs/env/update.html index 62014f8..be27ea0 100644 --- a/docs/env/update.html +++ b/docs/env/update.html @@ -1,28 +1,944 @@ - - + + Update | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Update

This page is about the Update class available in PeyrSharp.Env. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Update class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

GetLastVersionAsync(url)

Definition

Downloads the content of remote file as string. The remote file should contain the last version text. Do not provide the URL of an HTML page.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlLink of the file where the latest version is stored.

Usage

c#
using PeyrSharp.Env;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Update + +

+

+ This page is about the Update class + available in + PeyrSharp.Env. You can find here all of its methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The Update class is part of the + PeyrSharp.Env module, and is compatible + with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env
+
+

WARNING

+

+ Some methods, classes or features of + PeyrSharp.Env might not be available in + all platforms. +

+
+

+ Methods + +

+

+ GetLastVersionAsync(url) + +

+

+ Definition + +

+

+ Downloads the content of remote file as + string. The remote file should contain + the last version text. Do not provide the URL of an + HTML page. +

+
+

INFO

+

This method is asynchronous and awaitable.

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringurl + Link of the file where the latest version is + stored. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 private async void Main()
 {
     string lastVersion = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/Leo-Corporation/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt");
     // lastVersion would be equal to the content of this text files
 }
-

IsAvailable(currentVersion, remoteVersion)

Definition

Compares two versions. Returns a bool.

INFO

It is recommended to use this method with the GetLastVersionAsync() one.

Arguments

TypeNameMeaning
stringcurrentVersionThe current version of the app.
stringremoveVersionThe latest version, stored remotely.

Usage

c#
using PeyrSharp.Env;
+
+
+

+ IsAvailable(currentVersion, remoteVersion) + +

+

+ Definition + +

+

+ Compares two versions. Returns a bool. +

+
+

INFO

+

+ It is recommended to use this method with the + GetLastVersionAsync() + one. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringcurrentVersionThe current version of the app.
stringremoveVersionThe latest version, stored remotely.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Env;
 
 private async void Main()
 {
@@ -33,9 +949,92 @@
         ? "Updates are available."
         : "You are up-to-date.");
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/exceptions.html b/docs/exceptions.html index f1b2fe9..1cc79eb 100644 --- a/docs/exceptions.html +++ b/docs/exceptions.html @@ -1,27 +1,2254 @@ - - + + Exceptions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Exceptions

This page is about the exceptions available in PeyrSharp.Exceptions. They are grouped by category.

Compatibility

Exceptions are part of the PeyrSharp.Exceptions module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Exceptions
Framework.NET 5.NET 6.NET 7
Exceptions

Converters

RGBInvalidValueException

Definition

The RGBInvalidValueException is an exception used in the Converters class when you provide an invalid value for a RGB color.

Usage

c#
using PeyrSharp.Exceptions;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Exceptions + +

+

+ This page is about the exceptions available in + PeyrSharp.Exceptions. They are grouped by category. +

+

+ Compatibility + +

+

+ Exceptions are part of the + PeyrSharp.Exceptions module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Exceptions
Framework.NET 5.NET 6.NET 7
Exceptions
+

+ Converters + +

+

+ RGBInvalidValueException + +

+

+ Definition + +

+

+ The RGBInvalidValueException is an + exception used in the Converters class + when you provide an invalid value for a RGB color. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Exceptions;
 
 throw new RGBInvalidValueException("Please provide correct RGB values.");
-

HEXInvalidValueException

Definition

The HEXInvalidValueException is an exception used in the Converters class when you provide an invalid value for a HEX color.

Usage

c#
using PeyrSharp.Exceptions;
+
+
+

+ HEXInvalidValueException + +

+

+ Definition + +

+

+ The HEXInvalidValueException is an + exception used in the Converters class + when you provide an invalid value for a HEX color. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Exceptions;
 
 throw new HEXInvalidValueException("Please provide a correct HEX value.");
-

Guid

InvalidGuidLengthException

Definition

The InvalidGuidLengthException is an exception used in the Guid class when you provide an invalid value for the length of the Guid. You should provide a length between 1-32.

Usage

c#
using PeyrSharp.Exceptions;
+
+
+

+ Guid + +

+

+ InvalidGuidLengthException + +

+

+ Definition + +

+

+ The InvalidGuidLengthException is an + exception used in the Guid class when you + provide an invalid value for the length of the Guid. + You should provide a length between 1-32. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Exceptions;
 
 // Guid length
 int length = 45; // Will throw an error
@@ -30,9 +2257,100 @@
 {
     throw new InvalidGuidLengthException("The length of a Guid must be between 1 and 32.");
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/extensions.html b/docs/extensions.html index 0d7d960..be43a38 100644 --- a/docs/extensions.html +++ b/docs/extensions.html @@ -1,23 +1,859 @@ - - + + Extensions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Extensions

This page is about the PeyrSharp.Extensions module.

Compatibility

The PeyrSharp.Extensions module is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Extensions + +

+

+ This page is about the PeyrSharp.Extensions module. +

+

+ Compatibility + +

+

+ The PeyrSharp.Extensions module is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/extensions/array.html b/docs/extensions/array.html index 936de1e..2d83339 100644 --- a/docs/extensions/array.html +++ b/docs/extensions/array.html @@ -1,48 +1,1235 @@ - - + + ArrayExtensions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

ArrayExtensions

This page is about the ArrayExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.

INFO

This class is static.

Compatibility

The ArrayExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions

Methods

Append(item)

Definition

The Append<T>() method adds an item to an existing array of any type. It returns an array of the chosen type (T[]).

Arguments

TypeNameMeaning
TitemThe item to append in the array.

Usage

c#
using PeyrSharp.Extensions;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ ArrayExtensions + +

+

+ This page is about the + ArrayExtensions class available in + PeyrSharp.Extensions. You can find here all of its extension methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The ArrayExtensions class is part of the + PeyrSharp.Extensions module, and is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions
+

+ Methods + +

+

+ Append(item) + +

+

+ Definition + +

+

+ The Append<T>() method adds an item + to an existing array of any type. It returns an array + of the chosen type (T[]). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
TitemThe item to append in the array.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] numbers = { 1, 2, 3, 4 };
 int[] appendNumbers = numbers.Append(5);
 // appendNumbers: { 1, 2, 3, 4, 5 }
-

Append(items)

Definition

The Append<T>() method adds multiple items to an existing array of any type. It returns an array of the chosen type (T[]).

Arguments

TypeNameMeaning
params T[]itemsThe items to append in the array.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Append(items) + +

+

+ Definition + +

+

+ The Append<T>() method adds + multiple items to an existing array of any type. It + returns an array of the chosen type + (T[]). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
params T[]itemsThe items to append in the array.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] numbers = { 1, 2, 3, 4 };
 int[] appendNumbers = numbers.Append(5, 6);
 // appendNumbers: { 1, 2, 3, 4, 5, 6 }
-

RemoveElement(item)

Definition

The RemoveElement<T>() method removes an item from an array. It returns an array of the chosen type (T[]).

Arguments

TypeNameMeaning
TitemThe item to remove from the array.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ RemoveElement(item) + +

+

+ Definition + +

+

+ The RemoveElement<T>() method + removes an item from an array. It returns an array of + the chosen type (T[]). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
TitemThe item to remove from the array.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] numbers = { 1, 2, 3, 4, 5 };
 int[] remove = numbers.RemoveItem(5);
 // remove: { 1, 2, 3, 4 }
-

RemoveElement(items)

Definition

The RemoveElement<T>() method removes multiple items from an array. It returns an array of the chosen type (T[]).

Arguments

TypeNameMeaning
params T[]itemsThe items to remove from the array.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ RemoveElement(items) + +

+

+ Definition + +

+

+ The RemoveElement<T>() method + removes multiple items from an array. It returns an + array of the chosen type (T[]). +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
params T[]itemsThe items to remove from the array.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] numbers = { 1, 2, 3, 4, 5 };
 int[] remove = numbers.RemoveItem(5);
 // remove: { 1, 2, 3, 4 }
-

UnSplit(array, separator)

Definition

Concatenates the elements of a string array, using the specified separator between each element. Return a string that consists of the elements of array delimited by the separator string. If array has no elements, the method returns an empty string.

Arguments

TypeNameMeaning
stringarrayThe array of strings to concatenate.
stringseparatorThe string to use as a separator.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ UnSplit(array, separator) + +

+

+ Definition + +

+

+ Concatenates the elements of a + string array, using the specified + separator between each element. Return a + string that consists of the elements of + array delimited by the + separator string. If + array has no elements, the method returns + an empty string. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringarray + The array of strings to + concatenate. +
stringseparator + The string to use as a separator. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string[] array = { "a", "b", "c", "d" };
 string final = array.UnSplit(", "); // Concatenate the elements of the array with a comma and a space as a separator
 // final = "a, b, c, d"
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/extensions/double.html b/docs/extensions/double.html index a88db9e..638aa3b 100644 --- a/docs/extensions/double.html +++ b/docs/extensions/double.html @@ -1,87 +1,1965 @@ - - + + DoubleExtensions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

DoubleExtensions

This page is about the DoubleExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.

INFO

This class is static.

Compatibility

The DoubleExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions

Methods

Mean(values)

Definition

Calculates the mean (average) of a dataset. Returns the mean of the dataset as double.

Exceptions

TypeCondition
System.ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ DoubleExtensions + +

+

+ This page is about the + DoubleExtensions class available in + PeyrSharp.Extensions. You can find here all of its extension methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The DoubleExtensions class is part of the + PeyrSharp.Extensions module, and is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions
+

+ Methods + +

+

+ Mean(values) + +

+

+ Definition + +

+

+ Calculates the mean (average) of a dataset. Returns + the mean of the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
System.ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 double[] data = new double[] { 1.0, 2.0, 3.0, 4.0, 5.0 };
 double mean = data.Mean(); // 5
-

Median(values)

Definition

Calculates the median of a dataset. Returns the median of the dataset as double.

Exceptions

TypeCondition
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Median(values) + +

+

+ Definition + +

+

+ Calculates the median of a dataset. Returns the median + of the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 double[] data = new double[] { 1.2, 3.4, 2.5, 6.8, 5.7 };
 double median = data.Median();
 
 Console.WriteLine($"The median of the dataset is {median}"); // 3.4
-

Mode(values)

Definition

Calculates the mode of a dataset. Returns the mode of the dataset as double.

Exceptions

TypeCondition
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Mode(values) + +

+

+ Definition + +

+

+ Calculates the mode of a dataset. Returns the mode of + the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 double[] data = new double[] { 1.2, 3.4, 2.5, 6.8, 5.7 };
 double mode = data.Mode();
 
 Console.WriteLine($"The mode of the dataset is {mode}"); // 1.2
-

ToInt()

Definition

Converts a double value to an int. To achieve it, it uses the Math.Round() method.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ ToInt() + +

+

+ Definition + +

+

+ Converts a double value to an + int. To achieve it, it uses the + Math.Round() method. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int n = 45.6.ToInt();
 // n = 46
-

ToSeconds(timeUnits)

Definition

Converts a specified time unit value to seconds. For instance, you can convert days, hours or minutes to seconds. It returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ ToSeconds(timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to seconds. For + instance, you can convert days, hours or minutes to + seconds. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Extensions;
 
 double seconds = 5.ToSeconds(TimeUnits.Minutes);
 // seconds = 300
-

ToMinutes(timeUnits)

Definition

Converts a specified time unit value to minutes. For instance, you can convert days, hours or seconds to minutes. It returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ ToMinutes(timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to minutes. For + instance, you can convert days, hours or seconds to + minutes. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Extensions;
 
 double min = 120.ToMinutes(TimeUnits.Seconds);
 // min = 2
-

ToHours(timeUnits)

Definition

Converts a specified time unit value to hours. For instance, you can convert days, minutes or seconds to hours. It returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ ToHours(timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to hours. For + instance, you can convert days, minutes or seconds to + hours. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Extensions;
 
 double hours = 1.ToHours(TimeUnits.Days);
 // hours = 24
-

ToDays(timeUnits)

Definition

Converts a specified time unit value to days. For instance, you can convert hours, minutes or seconds to days. It returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ ToDays(timeUnits) + +

+

+ Definition + +

+

+ Converts a specified time unit value to days. For + instance, you can convert hours, minutes or seconds to + days. It returns a double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ TimeUnits + timeUnits + The unit of the time. (ex: minutes, hours...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.Extensions;
 
 double days = 72.ToDays(TimeUnits.Hours);
 // days = 3
-

ToByte(storageUnit)

Definition

Converts a size (kb, mb, ...) to byte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
TimeUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToByte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to byte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
TimeUnitsstorageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double byte = Storage.1(StorageUnits.Kilobyte);
 // byte = 1000
-

ToKilobyte(storageUnit)

Definition

Converts a size (kb, mb, ...) to kilobyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
StorageUnitsstorageUnitThe unit of the value. (ex: byte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToKilobyte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to kilobyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ StorageUnits + storageUnit + The unit of the value. (ex: byte, gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double kilobyte = 2000.ToKilobyte(StorageUnits.Byte);
 // kilobyte = 2
-

ToMegabyte(storageUnit)

Definition

Converts a size (kb, mb, ...) to megabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToMegabyte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to megabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double megabyte = 1500.ToMegabyte(StorageUnits.Kilobyte);
 // megabyte = 1.5
-

ToGigabyte(storageUnit)

Definition

Converts a size (kb, mb, ...) to gigabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, megabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToGigabyte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to gigabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + megabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double gigabyte = 1000.ToGigabyte(StorageUnits.Megabyte);
 // gigabyte = 1
-

ToTerabyte(storageUnit)

Definition

Converts a size (kb, mb, ...) to terabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToTerabyte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to terabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double terabyte = 1.ToTerabyte(StorageUnits.Petabyte);
 // terabyte = 1000
-

ToPetabyte(storageUnit)

Definition

Converts a size (kb, mb, ...) to petabyte. Returns a double value.

INFO

This method can also be used in PeyrSharp.Core.Converters.

Arguments

TypeNameMeaning
StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)

Usage

c#
using PeyrSharp.Core.Converters;
+
+
+

+ ToPetabyte(storageUnit) + +

+

+ Definition + +

+

+ Converts a size (kb, mb, ...) to petabyte. Returns a + double value. +

+
+

INFO

+

+ This method can also be used in + PeyrSharp.Core.Converters. +

+
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
+ StorageUnits + storageUnit + The unit of the value. (ex: kilobyte, + gigabyte...) +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core.Converters;
 
 double petabyte = 1000.ToPetabyte(StorageUnits.Terabyte);
 // petabyte = 1
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/extensions/int.html b/docs/extensions/int.html index 87e17d6..180086d 100644 --- a/docs/extensions/int.html +++ b/docs/extensions/int.html @@ -1,48 +1,1225 @@ - - + + IntExtensions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

IntExtensions

This page is about the IntExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.

INFO

This class is static.

Compatibility

The IntExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions

Methods

GetDivisors()

Definition

Gets all divisors of a specific number. Returns an array of int[].

Arguments

This method does not have any arguments.

Usage

c#
using PeyrSharp.Extensions;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ IntExtensions + +

+

+ This page is about the + IntExtensions class available in + PeyrSharp.Extensions. You can find here all of its extension methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The IntExtensions class is part of the + PeyrSharp.Extensions module, and is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions
+

+ Methods + +

+

+ GetDivisors() + +

+

+ Definition + +

+

+ Gets all divisors of a specific number. Returns an + array of int[]. +

+

+ Arguments + +

+

This method does not have any arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] divs = 16.GetDivisors(); // { 1, 2, 4, 8, 16 }
-

IsEven()

Definition

Checks if the number is even. Returns a bool.

Arguments

This method does not have any arguments.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ IsEven() + +

+

+ Definition + +

+

+ Checks if the number is even. Returns a + bool. +

+

+ Arguments + +

+

This method does not have any arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] divs = 16.IsEven(); // true
-

Mean(values)

Definition

Calculates the mean (average) of a dataset. Returns the mean of the dataset as double.

Exceptions

TypeCondition
System.ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Mean(values) + +

+

+ Definition + +

+

+ Calculates the mean (average) of a dataset. Returns + the mean of the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
System.ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] data = new int[] { 1, 2, 3, 4, 5 };
 double mean = data.Mean(); // 5
-

Median(values)

Definition

Calculates the median of a dataset. Returns the median of the dataset as double.

Exceptions

TypeCondition
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Median(values) + +

+

+ Definition + +

+

+ Calculates the median of a dataset. Returns the median + of the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] data = new int[] { 1, 2, 3, 5 };
 double median = data.Median();
 
 Console.WriteLine($"The median of the dataset is {median}"); // 2
-

Mode(values)

Definition

Calculates the mode of a dataset. Returns the mode of the dataset as double.

Exceptions

TypeCondition
ArgumentExceptionThrown if the dataset is empty.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Mode(values) + +

+

+ Definition + +

+

+ Calculates the mode of a dataset. Returns the mode of + the dataset as double. +

+

+ Exceptions + +

+ + + + + + + + + + + + + +
TypeCondition
ArgumentExceptionThrown if the dataset is empty.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int[] data = new int[] { 1, 2, 3, 5 };
 double mode = data.Mode();
 
 Console.WriteLine($"The mode of the dataset is {mode}"); // 1
-

ToDouble()

Definition

Converts an int to double.

Arguments

This method does not have any arguments.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ ToDouble() + +

+

+ Definition + +

+

+ Converts an int to double. +

+

+ Arguments + +

+

This method does not have any arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 double d = 16.ToDouble(); // 16.0d
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/extensions/string.html b/docs/extensions/string.html index ee92d0c..db59a4c 100644 --- a/docs/extensions/string.html +++ b/docs/extensions/string.html @@ -1,73 +1,1634 @@ - - + + StringExtensions | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

StringExtensions

This page is about the StringExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.

INFO

This class is static.

Compatibility

The StringExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions

Methods

CountWords()

Definition

Counts the number of words in a string. Returns int.

Arguments

This method has no arguments.

Usage

c#
using PeyrSharp.Extensions;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ StringExtensions + +

+

+ This page is about the + StringExtensions class available in + PeyrSharp.Extensions. You can find here all of its extension methods. +

+
+

INFO

+

This class is static.

+
+

+ Compatibility + +

+

+ The StringExtensions class is part of the + PeyrSharp.Extensions module, and is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Extensions
Framework.NET 5.NET 6.NET 7
Extensions
+

+ Methods + +

+

+ CountWords() + +

+

+ Definition + +

+

+ Counts the number of words in a string. + Returns int. +

+

+ Arguments + +

+

This method has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 int numberOfWords = "Hello, this is a test sentence!".CountWords();
 // numberOfWords = 6
-

CountWords(wordSeparator)

Definition

Counts the number of words in a string, with specified word separators. By default, the method uses those (if you don't pass any argument to it): , ,, ;, ., :, !, ?. Returns int.

Arguments

TypeNameMeaning
string[]wordSeparatorThe separator of the words.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ CountWords(wordSeparator) + +

+

+ Definition + +

+

+ Counts the number of words in a string, + with specified word separators. By default, the method + uses those (if you don't pass any argument to it): + , ,, ;, + ., :, !, + ?. Returns int. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
string[]wordSeparatorThe separator of the words.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string[] wordSeparator = { " ", ",", ":", "!", "?", ";", "." };
 int numberOfWords = "Hello, this is a test sentence!".CountWords(wordSeparator);
 // numberOfWords = 6
-

EndsWithSamePunctuation(stringToCheck)

Definition

Checks if a string is ending with the same punctuation than an other one. Returns a bool; true if it is the case.

Arguments

TypeNameMeaning
stringstringToCheckThe string to compare.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ EndsWithSamePunctuation(stringToCheck) + +

+

+ Definition + +

+

+ Checks if a string is ending with the + same punctuation than an other one. Returns a + bool; true if it is the + case. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringstringToCheckThe string to compare.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string a = "This is a test sentence.";
 string b = "This is an another test sentence.";
 
 a.EndsWithSamePunctuation(b); // true
-

EndsWithSamePunctuation(stringToCheck, punctuationToCheck)

Definition

Checks if a string is ending with the same specified punctuation than an other one. Returns a bool; true if it is the case.

Arguments

TypeNameMeaning
stringstringToCheckThe string to compare.
stringpunctuationToCheckThe punctuation sign to check for.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ EndsWithSamePunctuation(stringToCheck, + punctuationToCheck) + +

+

+ Definition + +

+

+ Checks if a string is ending with the + same specified punctuation than an + other one. Returns a bool; + true if it is the case. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringstringToCheckThe string to compare.
stringpunctuationToCheckThe punctuation sign to check for.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string a = "This is a test sentence.";
 string b = "This is an another test sentence.";
 
 a.EndsWithSamePunctuation(b, "."); // true
-

EncryptAes(key)

Definitions

Encrypts a string using AES encryption. Returns the encrypted content as a string as well.

Arguments

TypeNameMeaning
stringkeyThe encryption key. This is the same key that will be used to decrypt the text.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ EncryptAes(key) + +

+

+ Definitions + +

+

+ Encrypts a string using AES encryption. + Returns the encrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringkey + The encryption key. This is the same key that + will be used to decrypt the text. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string encrypted = "Hello!".EncryptAes("password");
 // encrypted = 6NvvTBntd2PdFxXzVbccLw==
-

DecryptAes(key)

Definitions

Decrypts a string using AES encryption. Returns the decrypted content as a string as well.

Arguments

TypeNameMeaning
stringkeyThe encryption key that was used during the encryption process.

Usage

c#
using PeyrSharp.Core;
+
+
+

+ DecryptAes(key) + +

+

+ Definitions + +

+

+ Decrypts a string using AES encryption. + Returns the decrypted content as a + string as well. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringkey + The encryption key that was used during the + encryption process. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Core;
 
 string text = "6NvvTBntd2PdFxXzVbccLw==".DecryptAes("password");
 // text = Hello!
-

HasRepeatedCharacters()

Definition

Checks if a letter or character is being repeated in a string. Returns bool.

INFO

Only returns true if a character is repeated more than three times. For instance, "11" will return false, whereas "aaaa" will return true.

Arguments

This methods has no arguments.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ HasRepeatedCharacters() + +

+

+ Definition + +

+

+ Checks if a letter or character is being repeated in a + string. Returns bool. +

+
+

INFO

+

+ Only returns true if a character is + repeated more than three times. For instance, + "11" will return false, + whereas "aaaa" will return + true. +

+
+

+ Arguments + +

+

This methods has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 "111".HasRepeatedCharacters(); // true
-

SplitLines()

Definition

Splits a string lines to an array. Returns string[].

INFO

The method uses the string.Split() method under the hood, which means that it is providing it the following separators: \n, \r, \r\n.

Arguments

This methods has no arguments.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ SplitLines() + +

+

+ Definition + +

+

+ Splits a string lines to an array. + Returns string[]. +

+
+

INFO

+

+ The method uses the + string.Split() method under the hood, + which means that it is providing it the following + separators: \n, \r, + \r\n. +

+
+

+ Arguments + +

+

This methods has no arguments.

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string[] lines = "Hello\nWorld".SplitLines();
 // lines = { "Hello", "World" }
-

ToUpperAt(str, r)

Definition

Returns a new string in which the characters in a specified range of the current string are converted to uppercase. Returns a string that is equivalent to the current string, but with the characters in the specified range converted to uppercase.

Arguments

TypeNameMeaning
stringstrThe string to modify.
RangerThe range of characters to convert to uppercase.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ ToUpperAt(str, r) + +

+

+ Definition + +

+

+ Returns a new string in which the + characters in a specified range of the current + string are converted to uppercase. + Returns a string that is equivalent to + the current string, but with the + characters in the specified range converted to + uppercase. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
stringstrThe string to modify.
Ranger + The range of characters to convert to uppercase. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string str = "aBcDeFgHiJ";
 string upper = str.ToUpperAt(2..6); // Convert the characters at indexes 2 to 6 (inclusive) to uppercase
 // upper = "aBCDEFGhij"
-

ToUpperAt(s)

Definition

Uppercases the first letter of a string. Returns a string with the first letter uppercased.

Arguments

TypeNameMeaning
stringsThe string to capitalize.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ ToUpperAt(s) + +

+

+ Definition + +

+

+ Uppercases the first letter of a string. + Returns a string with the first letter + uppercased. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
stringsThe string to capitalize.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string str = "test";
 string upper = str.ToUpperAt(); // Uppercase the first letter of the string
 // upper = "Test"
-

Reverse(input)

Definition

Reverses a string.

Arguments

TypeNameDescription
stringinputThe string to reverse.

Returns

A string representing the reversed input.

Usage

c#
using PeyrSharp.Extensions;
+
+
+

+ Reverse(input) + +

+

+ Definition + +

+

Reverses a string.

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameDescription
stringinputThe string to reverse.
+

+ Returns + +

+

+ A string representing the reversed input. +

+

+ Usage + +

+
+ c# +
using PeyrSharp.Extensions;
 
 string reversed = "Hello, world!".Reverse();
 // Output: "!dlrow ,olleH"
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/get-started.html b/docs/get-started.html index b8fe6c9..ab7a849 100644 --- a/docs/get-started.html +++ b/docs/get-started.html @@ -1,32 +1,2458 @@ - - + + Get Started | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Get Started

Packages and modules

Before installing PeyrSharp, you may want to consider what features you will actually need to use in your project. Indeed, PeyrSharp is divided in multiple modules and packages.

If you think you need all the features of PeyrSharp, you can directly install the PeyrSharp NuGet package. However, you can also install the packages that you only need in your project. Here's a list of all the packages and their features:

PeyrSharp, the main package, that contains all of the followings:

PeyrSharp.Core, the basic methods and features of C#
  • Maths
  • Password
  • Guid
  • Converters
  • Internet
  • Crypt
PeyrSharp.Env, methods related to the file system and to the current execution environment.
  • FileSys
  • Logger
  • Update
  • System
PeyrSharp.Enums, all enumerations used by PeyrSharp
  • LogLevel
  • WindowsVersion
  • TimeUnits
  • SystemThemes
  • OperatingSystems
  • StorageUnits
  • ControlAlignment
  • PasswordPresets
  • PasswordStrength
PeyrSharp.Exceptions, all exceptions used by PeyrSharp
  • RGBInvalidValueException
  • HEXInvalidValueException
  • InvalidGuidLengthException
PeyrSharp.Extensions, extension methods, that extends basic types, such as string, int, double or arrays (T[]).
  • String
  • Int
  • Double
  • Array (T[])
PeyrSharp.UiHelpers, methods related to Windows Forms or to the Windows Presentation Framework (WPF).
  • WinForms
  • Screen
  • WPF

Compatibility

Platforms

Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platforms.

Package/PlatformWindowsmacOSLinux + others
Core
Env⚠️⚠️
Enums
Exceptions
Extensions
UiHelpers

Caption:

  • ✅ Full Support
  • ⚠️ Partial Support
  • ❌ Unsupported platform

Frameworks

PeyrSharp is available in the following frameworks

  • .NET 5
  • .NET 6
  • .NET 7 (soon)

INFO

.NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported.

Installation methods

PeyrShall is available on NuGet, you can install it by running the following command:

.NET CLI

You can add PeyrSharp to your project the .NET CLI.

powershell
dotnet add package PeyrSharp --version 1.0.0.2211
-

Package Manager

sh
NuGet\Install-Package PeyrSharp -Version 1.0.0.2211
-

Package Reference

You can specify in your project file that it is dependent on PeyrSharp.

xml
<PackageReference Include="PeyrSharp" Version="1.0.0.2211" />
-

Start coding

To call methods and classes included in PeyrSharp, you will need to add the corresponding using directives in your code file.

c#
using PeyrSharp.Core;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Get Started + +

+

+ Packages and modules + +

+

+ Before installing PeyrSharp, you may want to consider + what features you will actually need to use in your + project. Indeed, PeyrSharp is divided in multiple + modules and packages. +

+

+ If you think you need all the features of PeyrSharp, + you can directly install the PeyrSharp NuGet package. + However, you can also install the packages that you + only need in your project. Here's a list of all + the packages and their features: +

+

+ PeyrSharp, the main package, that + contains all of the followings: +

+
+ + PeyrSharp.Core, the basic methods + and features of C# + +
    +
  • Maths
  • +
  • Password
  • +
  • Guid
  • +
  • Converters
  • +
  • Internet
  • +
  • Crypt
  • +
+
+
+ + PeyrSharp.Env, methods related to + the file system and to the current execution + environment. + +
    +
  • FileSys
  • +
  • Logger
  • +
  • Update
  • +
  • System
  • +
+
+
+ + PeyrSharp.Enums, all enumerations + used by PeyrSharp + +
    +
  • LogLevel
  • +
  • WindowsVersion
  • +
  • TimeUnits
  • +
  • SystemThemes
  • +
  • OperatingSystems
  • +
  • StorageUnits
  • +
  • ControlAlignment
  • +
  • PasswordPresets
  • +
  • PasswordStrength
  • +
+
+
+ + PeyrSharp.Exceptions, all + exceptions used by PeyrSharp + +
    +
  • RGBInvalidValueException
  • +
  • HEXInvalidValueException
  • +
  • InvalidGuidLengthException
  • +
+
+
+ + PeyrSharp.Extensions, extension + methods, that extends basic types, such as + string, int, + double or arrays (T[]). + +
    +
  • String
  • +
  • Int
  • +
  • Double
  • +
  • Array (T[])
  • +
+
+
+ + PeyrSharp.UiHelpers, methods + related to Windows Forms or to the Windows + Presentation Framework (WPF). + +
    +
  • WinForms
  • +
  • Screen
  • +
  • WPF
  • +
+
+

+ Compatibility + +

+

+ Platforms + +

+

+ Some modules of PeyrSharp are targeting features only + available in specific operating systems. Thus, some + packages aren't available on all platforms. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Env⚠️⚠️
Enums
Exceptions
Extensions
UiHelpers
+

Caption:

+
    +
  • ✅ Full Support
  • +
  • ⚠️ Partial Support
  • +
  • ❌ Unsupported platform
  • +
+

+ Frameworks + +

+

+ PeyrSharp is available in the following frameworks +

+
    +
  • .NET 5
  • +
  • .NET 6
  • +
  • .NET 7 (soon)
  • +
+
+

INFO

+

+ .NET Framework and .NET Core are not targeted by + PeyrSharp, since they are no longer supported. +

+
+

+ Installation methods + +

+

+ PeyrShall is available on NuGet, you can install it by + running the following command: +

+

+ .NET CLI + +

+

+ You can add PeyrSharp to your project the .NET CLI. +

+
+ powershell +
dotnet add package PeyrSharp --version 1.0.0.2211
+
+
+

+ Package Manager + +

+
+ sh +
NuGet\Install-Package PeyrSharp -Version 1.0.0.2211
+
+
+

+ Package Reference + +

+

+ You can specify in your project file that it is + dependent on PeyrSharp. +

+
+ xml +
<PackageReference Include="PeyrSharp" Version="1.0.0.2211" />
+
+
+

+ Start coding + +

+

+ To call methods and classes included in PeyrSharp, you + will need to add the corresponding using directives in + your code file. +

+
+ c# +
using PeyrSharp.Core;
 using PeyrSharp.Env;
 using PeyrSharp.Enums;
 using PeyrSharp.Exceptions;
 using PeyrSharp.Extensions;
 using PeyrSharp.UiHelpers; // Windows only
-

For more information, you can check the reference

Released under the MIT License.

- - +
+
+

+ For more information, you can check the + reference +

+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/index.html b/docs/index.html index ee6f2dd..fe1cd07 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,23 +1,605 @@ - - - PeyrSharp | A C# library designed to make developers' job easier. - - + + + + PeyrSharp | A C# library designed to make developers' job easier. + + + - - - - - - + + + + + + -
Skip to content

PeyrSharp

Made for you.

A C# library designed to make developers' job easier.

PeyrSharp

Easy-to-use

Using PeyrSharp in a project is very easy and intuitive.

🚀

.NET Powered

PeyrSharp is built using C# and .NET. It's available for projects targeting .NET 5 and higher.

🖥️

Cross-Platform

PeyrSharp is compatible with every operating systems that .NET supports.

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+ +
+
+ +
+
+
+ +

+ PeyrSharp +

+

Made for you.

+

+ A C# library designed to make developers' job easier. +

+ +
+ + +
+ Reference +
+ +
+
+
+
+
+ PeyrSharp +
+
+
+
+ +
+
+
+ +
+ +
+
+

Easy-to-use

+

+ Using PeyrSharp in a project is very easy and + intuitive. +

+ +
+
+
+
+ +
+
🚀
+

.NET Powered

+

+ PeyrSharp is built using C# and .NET. It's available + for projects targeting .NET 5 and higher. +

+ +
+
+
+
+ +
+
🖥️
+

Cross-Platform

+

+ PeyrSharp is compatible with every operating systems + that .NET supports. +

+ +
+
+
+ +
+
+
+ +
+
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/intro.html b/docs/intro.html index 442dee8..42dd12e 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -1,23 +1,820 @@ - - + + Introduction | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Introduction

The roots

In March 2020, we published LeoCorpLibrary, which was also a C# library that contains useful methods. When we started the development of it, we didn't know where the project will go yet. Over the releases, we've added more and more methods and new features. However, the meaning and the purpose of LeoCorpLibrary was becoming less clear for everyone; it was becoming a mess. This is why we decided to rather not release v5, but instead, we decided to make a brand new .NET Library, PeyrSharp.

Our next product

PeyrSharp is a C# written library designed to make developers' life easier. We've all written code that we wish we hadn't. PeyrSharp is here to respond to this need; by implementing useful methods in various domains: Mathematics, Web/HTTP requests, unit converters, extensions, environment-related operations, and more!

Modules

PeyrSharp is divided in multiple packages:

PeyrSharp, the main package, that contains all of the followings:

PeyrSharp.Core, the basic methods and features of C#
  • Maths
  • Password
  • Guid
  • Converters
  • Internet
  • Crypt
PeyrSharp.Env, methods related to the file system and to the current execution environment.
  • FileSys
  • Logger
  • Update
  • System
PeyrSharp.Enums, all enumerations used by PeyrSharp
  • WindowsVersion
  • TimeUnits
  • SystemThemes
  • OperatingSystems
  • StorageUnits
  • ControlAlignment
  • PasswordPresets
  • PasswordStrength
PeyrSharp.Exceptions, all exceptions used by PeyrSharp
  • RGBInvalidValueException
  • HEXInvalidValueException
  • InvalidGuidLengthException
PeyrSharp.Extensions, extension methods, that extends basic types, such as string, int, double or arrays (T[]).
  • String
  • Int
  • Double
  • Array (T[])
PeyrSharp.UiHelpers, methods related to Windows Forms or to the Windows Presentation Framework (WPF).
  • WinForms
  • Screen
  • WPF

Compatibility

Platforms

Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platform.

Package/PlatformWindowsmacOSLinux + others
Core
Env⚠️⚠️
Enums
Exceptions
Extensions
UiHelpers

Caption:

  • ✅ Full Support
  • ⚠️ Partial Support
  • ❌ Unsupported platform

Frameworks

PeyrSharp is available in the following frameworks

  • .NET 5
  • .NET 6
  • .NET 7 (soon)

NOTE

.NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported.

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Introduction + +

+

+ The roots + +

+

+ In March 2020, we published LeoCorpLibrary, which was + also a C# library that contains useful methods. When + we started the development of it, we didn't know + where the project will go yet. Over the releases, + we've added more and more methods and new + features. However, the meaning and the purpose of + LeoCorpLibrary was becoming less clear for everyone; + it was becoming a mess. This is why we decided to + rather not release v5, but instead, we decided to make + a brand new .NET Library, PeyrSharp. +

+

+ Our next product + +

+

+ PeyrSharp is a C# written library designed to make + developers' life easier. We've all written + code that we wish we hadn't. PeyrSharp is here to + respond to this need; by implementing useful methods + in various domains: Mathematics, Web/HTTP requests, + unit converters, extensions, environment-related + operations, and more! +

+

+ Modules + +

+

PeyrSharp is divided in multiple packages:

+

+ PeyrSharp, the main package, that + contains all of the followings: +

+
+ + PeyrSharp.Core, the basic methods + and features of C# + +
    +
  • Maths
  • +
  • Password
  • +
  • Guid
  • +
  • Converters
  • +
  • Internet
  • +
  • Crypt
  • +
+
+
+ + PeyrSharp.Env, methods related to + the file system and to the current execution + environment. + +
    +
  • FileSys
  • +
  • Logger
  • +
  • Update
  • +
  • System
  • +
+
+
+ + PeyrSharp.Enums, all enumerations + used by PeyrSharp + +
    +
  • WindowsVersion
  • +
  • TimeUnits
  • +
  • SystemThemes
  • +
  • OperatingSystems
  • +
  • StorageUnits
  • +
  • ControlAlignment
  • +
  • PasswordPresets
  • +
  • PasswordStrength
  • +
+
+
+ + PeyrSharp.Exceptions, all + exceptions used by PeyrSharp + +
    +
  • RGBInvalidValueException
  • +
  • HEXInvalidValueException
  • +
  • InvalidGuidLengthException
  • +
+
+
+ + PeyrSharp.Extensions, extension + methods, that extends basic types, such as + string, int, + double or arrays (T[]). + +
    +
  • String
  • +
  • Int
  • +
  • Double
  • +
  • Array (T[])
  • +
+
+
+ + PeyrSharp.UiHelpers, methods + related to Windows Forms or to the Windows + Presentation Framework (WPF). + +
    +
  • WinForms
  • +
  • Screen
  • +
  • WPF
  • +
+
+

+ Compatibility + +

+

+ Platforms + +

+

+ Some modules of PeyrSharp are targeting features only + available in specific operating systems. Thus, some + packages aren't available on all platform. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
Core
Env⚠️⚠️
Enums
Exceptions
Extensions
UiHelpers
+

Caption:

+
    +
  • ✅ Full Support
  • +
  • ⚠️ Partial Support
  • +
  • ❌ Unsupported platform
  • +
+

+ Frameworks + +

+

+ PeyrSharp is available in the following frameworks +

+
    +
  • .NET 5
  • +
  • .NET 6
  • +
  • .NET 7 (soon)
  • +
+
+

NOTE

+

+ .NET Framework and .NET Core are not targeted by + PeyrSharp, since they are no longer supported. +

+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/reference.html b/docs/reference.html index 9c33683..c8d8341 100644 --- a/docs/reference.html +++ b/docs/reference.html @@ -1,23 +1,2383 @@ - - + + Reference | PeyrSharp - - + + - - - - - - + + + + + + - - - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Reference + +

+

The reference of PeyrSharp.

+

+ PeyrSharp.Core + +

+ +

+ PeyrSharp.Env + +

+ +

+ PeyrSharp.Enums + +

+ +

+ PeyrSharp.Exceptions + +

+ +

+ PeyrSharp.Extensions + +

+ +

+ PeyrSharp.UiHelpers + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/ui-helpers.html b/docs/ui-helpers.html index 6b5f401..e428850 100644 --- a/docs/ui-helpers.html +++ b/docs/ui-helpers.html @@ -1,23 +1,844 @@ - - + + UiHelpers | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

UiHelpers

This page is about the exceptions available in PeyrSharp.UiHelpers. They are grouped by category.

Compatibility

UiHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers

Classes

Released under the MIT License.

- - +
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ UiHelpers + +

+

+ This page is about the exceptions available in + PeyrSharp.UiHelpers. They are grouped by + category. +

+

+ Compatibility + +

+

+ UiHelpers are part of the + PeyrSharp.UiHelpers module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers
+

+ Classes + +

+ +
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/ui-helpers/screen.html b/docs/ui-helpers/screen.html index f7dec6e..6ccf15c 100644 --- a/docs/ui-helpers/screen.html +++ b/docs/ui-helpers/screen.html @@ -1,21 +1,822 @@ - - + + Screen | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

Screen

This page is about the ScreenHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.

Compatibility

ScreenHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers

Methods

GetDpi(form)

Definition

Gets the DPI of the screen where the Windows Form is located. It returns a double value.

Arguments

TypeNameMeaning
FormformThe form to get the DPI of.

Usage

c#
using PeyrSharp.UiHelpers;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ Screen + +

+

+ This page is about the + ScreenHelpers class available in + PeyrSharp.UiHelpers. This page is about all of its methods. +

+

+ Compatibility + +

+

+ ScreenHelpers are part of the + PeyrSharp.UiHelpers module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers
+

+ Methods + +

+

+ GetDpi(form) + +

+

+ Definition + +

+

+ Gets the DPI of the screen where the Windows + Form is located. It returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
FormformThe form to get the DPI of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows.Forms;
 
@@ -26,7 +827,71 @@
         MessageBox.Show(ScreenHelpers.GetDpi(this));
     }
 }
-

GetDpi(window)

Definition

Gets the DPI of the screen where the Window is located. It returns a double value.

Arguments

TypeNameMeaning
WindowwindowThe Window to get the DPI of.

Usage

c#
using PeyrSharp.UiHelpers;
+
+
+

+ GetDpi(window) + +

+

+ Definition + +

+

+ Gets the DPI of the screen where the + Window is located. It returns a + double value. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
WindowwindowThe Window to get the DPI of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows;
 
@@ -37,7 +902,79 @@
         MessageBox.Show(ScreenHelpers.GetDpi(this));
     }
 }
-

GetScreenScaling(form)

Definition

Gets the scaling of the screen where the Windows Form is located. It returns a double value.

Possible values:

  • 100
  • 125
  • 150
  • 175
  • 200

Arguments

TypeNameMeaning
FormformThe form to get the scale of.

Usage

c#
using PeyrSharp.UiHelpers;
+
+
+

+ GetScreenScaling(form) + +

+

+ Definition + +

+

+ Gets the scaling of the screen where the Windows + Form is located. It returns a + double value. +

+

Possible values:

+
    +
  • 100
  • +
  • 125
  • +
  • 150
  • +
  • 175
  • +
  • 200
  • +
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
FormformThe form to get the scale of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows.Forms;
 
@@ -48,7 +985,79 @@
         MessageBox.Show(ScreenHelpers.GetScreenScaling(this));
     }
 }
-

GetScreenScaling(window)

Definition

Gets the scaling of the screen where the Window is located. It returns a double value.

Possible values:

  • 100
  • 125
  • 150
  • 175
  • 200

Arguments

TypeNameMeaning
WindowwindowThe window to get the scale of.

Usage

c#
using PeyrSharp.UiHelpers;
+
+
+

+ GetScreenScaling(window) + +

+

+ Definition + +

+

+ Gets the scaling of the screen where the + Window is located. It returns a + double value. +

+

Possible values:

+
    +
  • 100
  • +
  • 125
  • +
  • 150
  • +
  • 175
  • +
  • 200
  • +
+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
WindowwindowThe window to get the scale of.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows;
 
@@ -59,9 +1068,102 @@
         MessageBox.Show(ScreenHelpers.GetScreenScaling(this));
     }
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/ui-helpers/winforms.html b/docs/ui-helpers/winforms.html index 067c261..facdf85 100644 --- a/docs/ui-helpers/winforms.html +++ b/docs/ui-helpers/winforms.html @@ -1,21 +1,828 @@ - - + + WinForms | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

WinForms

This page is about the WinFormsHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.

Compatibility

WinFormsHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers

Methods

CenterControl(control, form)

Definition

Centers horizontally and vertically a Control on a Form.

Arguments

TypeNameMeaning
ControlcontrolThe control to center.
FormformThe form where the control needs to be centered.

Usage

c#
using PeyrSharp.UiHelpers;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ WinForms + +

+

+ This page is about the + WinFormsHelpers class available in + PeyrSharp.UiHelpers. This page is about all of its methods. +

+

+ Compatibility + +

+

+ WinFormsHelpers are part of the + PeyrSharp.UiHelpers module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers
+

+ Methods + +

+

+ CenterControl(control, form) + +

+

+ Definition + +

+

+ Centers horizontally and vertically a + Control on a Form. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
ControlcontrolThe control to center.
Formform + The form where the control needs to be centered. +
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows.Forms;
 
@@ -27,7 +834,88 @@
         WinFormsHelpers.CenterControl(button, this);
     }
 }
-

CenterControl(control, form, controlAlignment)

Definition

Centers a Control on a Form, with a specific ControlAlignment.

Arguments

TypeNameMeaning
ControlcontrolThe control to center.
FormformThe form where the control needs to be centered.
ControlAlignmentcontrolAlignmentThe alignment of the control.

Usage

c#
using PeyrSharp.Enums;
+
+
+

+ CenterControl(control, form, controlAlignment) + +

+

+ Definition + +

+

+ Centers a Control on a Form, + with a specific + ControlAlignment. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameMeaning
ControlcontrolThe control to center.
Formform + The form where the control needs to be centered. +
ControlAlignmentcontrolAlignmentThe alignment of the control.
+

+ Usage + +

+
+ c# +
using PeyrSharp.Enums;
 using PeyrSharp.UiHelpers;
 using System;
 using System.Windows.Forms;
@@ -42,7 +930,70 @@
         WinFormsHelpers.CenterControl(button, this, ControlAlignment.Vertical);
     }
 }
-

CenterForm(form)

Definition

Centers horizontally and vertically a Form on the screen.

Arguments

TypeNameMeaning
FormformThe form to center.

Usage

c#
using PeyrSharp.UiHelpers;
+
+
+

+ CenterForm(form) + +

+

+ Definition + +

+

+ Centers horizontally and vertically a + Form on the screen. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
FormformThe form to center.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 using System;
 using System.Windows.Forms;
 
@@ -54,9 +1005,100 @@
         WinFormsHelpers.CenterForm(this); 
     }
 }
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + diff --git a/docs/ui-helpers/wpf.html b/docs/ui-helpers/wpf.html index 4198329..eca429e 100644 --- a/docs/ui-helpers/wpf.html +++ b/docs/ui-helpers/wpf.html @@ -1,27 +1,911 @@ - - + + WPF | PeyrSharp - - + + - - - - - - + + + + + + -
Skip to content
On this page

WPF

This page is about the WpfHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.

Compatibility

WinFormsHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers

Methods

CenterWindow(window)

Definition

Centers a Window on the primary screen.

Arguments

TypeNameMeaning
WindowwindowThe Window to center.

Usage

c#
using PeyrSharp.UiHelpers;
+    
+
+ + Skip to content +
+
+
+
+
+ PeyrSharp +
+
+
+
+
+ + + + +
+ +
+ +
+ + +
+ +
+
+
+
+ +
+
+ +
+ +
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+ On this page +
+ +
+
+ +
+ +
+
+
+
+
+
+ +
+
+
+

+ WPF + +

+

+ This page is about the WpfHelpers class + available in + PeyrSharp.UiHelpers. This page is about all of its methods. +

+

+ Compatibility + +

+

+ WinFormsHelpers are part of the + PeyrSharp.UiHelpers module, which is + compatible with all of these frameworks and platforms: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package/PlatformWindowsmacOSLinux + others
UiHelpers
Framework.NET 5.NET 6.NET 7
UiHelpers
+

+ Methods + +

+

+ CenterWindow(window) + +

+

+ Definition + +

+

+ Centers a Window on the primary screen. +

+

+ Arguments + +

+ + + + + + + + + + + + + + + +
TypeNameMeaning
WindowwindowThe Window to center.
+

+ Usage + +

+
+ c# +
using PeyrSharp.UiHelpers;
 
 Window window = new Window();
 WpfHelpers.CenterWindow(window); // Center the window on the primary screen
-

Released under the MIT License.

- - +
+
+
+
+
+ + +
+
+
+ +
+
+
+
+

+ Released under the MIT License. +

+ +
+
+ +
+
+ - \ No newline at end of file + From a5fb341ea0fbf5c03c9a0dfcd75556c1b6770edc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Peyronnet?= Date: Sat, 6 May 2023 08:25:07 +0200 Subject: [PATCH 02/14] Renamed repo owner --- Documentation/.vitepress/config.js | 6 +- Documentation/env/update.md | 42 +++++----- Documentation/package.json | 6 +- NUGET_README.md | 79 +++++++++++-------- PeyrSharp.Core/PeyrSharp.Core.csproj | 4 +- PeyrSharp.Enums/PeyrSharp.Enums.csproj | 64 +++++++-------- PeyrSharp.Env/PeyrSharp.Env.csproj | 8 +- .../PeyrSharp.Exceptions.csproj | 4 +- .../PeyrSharp.Extensions.csproj | 10 +-- .../PeyrSharp.UiHelpers.csproj | 71 +++++++++-------- PeyrSharp/PeyrSharp.csproj | 30 +++---- README.md | 76 +++++++++++------- docs/404.html | 6 +- docs/assets/env_update.md.23d652b4.js | 22 +++++- docs/core.html | 8 +- docs/core/converters.html | 8 +- docs/core/converters/angle.html | 8 +- docs/core/converters/colors/hex.html | 8 +- docs/core/converters/colors/hsv.html | 8 +- docs/core/converters/colors/rgb.html | 8 +- docs/core/converters/distances.html | 8 +- docs/core/converters/energies.html | 8 +- docs/core/converters/masses.html | 8 +- docs/core/converters/speeds.html | 8 +- docs/core/converters/storage.html | 8 +- docs/core/converters/temperatures.html | 8 +- docs/core/converters/time.html | 8 +- docs/core/converters/volumes.html | 8 +- docs/core/crypt.html | 8 +- docs/core/guid-options.html | 8 +- docs/core/guid.html | 8 +- docs/core/internet.html | 8 +- docs/core/maths.html | 8 +- docs/core/maths/algebra.html | 8 +- docs/core/maths/geometry.html | 8 +- docs/core/maths/geometry/circle.html | 8 +- docs/core/maths/geometry/cone.html | 8 +- docs/core/maths/geometry/cube.html | 8 +- docs/core/maths/geometry/cylinder.html | 8 +- docs/core/maths/geometry/diamond.html | 8 +- docs/core/maths/geometry/hexagon.html | 8 +- docs/core/maths/geometry/pyramid.html | 8 +- docs/core/maths/geometry/rectangle.html | 8 +- docs/core/maths/geometry/sphere.html | 8 +- docs/core/maths/geometry/triangle.html | 8 +- docs/core/maths/percentages.html | 8 +- docs/core/maths/proba.html | 8 +- docs/core/maths/stats.html | 8 +- docs/core/maths/trigonometry.html | 8 +- docs/core/password.html | 8 +- docs/enumerations.html | 8 +- docs/env.html | 8 +- docs/env/filesys.html | 8 +- docs/env/logger.html | 8 +- docs/env/system.html | 8 +- docs/env/update.html | 12 +-- docs/exceptions.html | 8 +- docs/extensions.html | 8 +- docs/extensions/array.html | 8 +- docs/extensions/double.html | 8 +- docs/extensions/int.html | 8 +- docs/extensions/string.html | 8 +- docs/get-started.html | 8 +- docs/index.html | 6 +- docs/intro.html | 8 +- docs/reference.html | 8 +- docs/ui-helpers.html | 8 +- docs/ui-helpers/screen.html | 8 +- docs/ui-helpers/winforms.html | 8 +- docs/ui-helpers/wpf.html | 8 +- 70 files changed, 465 insertions(+), 413 deletions(-) diff --git a/Documentation/.vitepress/config.js b/Documentation/.vitepress/config.js index 9979310..a6fc83d 100644 --- a/Documentation/.vitepress/config.js +++ b/Documentation/.vitepress/config.js @@ -10,12 +10,12 @@ export default { { text: "Guide", link: "/get-started" }, { text: "Reference", link: "/reference" }, ], - repo: "Leo-Corporation/PeyrSharp", + repo: "DevyusCode/PeyrSharp", docsDir: "documentation", docsBranch: "main", editLink: { pattern: - "https://github.com/Leo-Corporation/PeyrSharp/edit/main/Documentation/:path", + "https://github.com/DevyusCode/PeyrSharp/edit/main/Documentation/:path", text: "Edit this page on GitHub", }, footer: { @@ -30,7 +30,7 @@ export default { socialLinks: [ { icon: "github", - link: "https://github.com/Leo-Corporation/PeyrSharp", + link: "https://github.com/DevyusCode/PeyrSharp", }, { icon: "twitter", diff --git a/Documentation/env/update.md b/Documentation/env/update.md index c73dad7..f7c6298 100644 --- a/Documentation/env/update.md +++ b/Documentation/env/update.md @@ -1,4 +1,5 @@ # Update + This page is about the `Update` class available in [`PeyrSharp.Env`](/env.md). You can find here all of its methods. @@ -10,19 +11,22 @@ This class is `static`. The `Update` class is part of the `PeyrSharp.Env` module, and is compatible with all of these frameworks and platforms: -| Package/Platform | Windows | macOS | Linux + others | -|------------------ |--------- |------- |---------------- | -| Env | ✅ | ✅ | ✅ | -| **Framework** | **.NET 5** | **.NET 6** | **.NET 7** | -| Env | ✅ | ✅ | ✅ | +| Package/Platform | Windows | macOS | Linux + others | +| ---------------- | ---------- | ---------- | -------------- | +| Env | ✅ | ✅ | ✅ | +| **Framework** | **.NET 5** | **.NET 6** | **.NET 7** | +| Env | ✅ | ✅ | ✅ | ::: warning Some methods, classes or features of `PeyrSharp.Env` might not be available in all platforms. ::: ## Methods + ### GetLastVersionAsync(url) + #### Definition + Downloads the content of remote file as `string`. The remote file should contain the last version text. Do not provide the URL of an HTML page. ::: info @@ -31,24 +35,26 @@ This method is asynchronous and awaitable. #### Arguments -| Type | Name | Meaning | -|------------ |------------ |----------------------------------------------------------- | -| `string` | `url` | Link of the file where the latest version is stored. | +| Type | Name | Meaning | +| -------- | ----- | ---------------------------------------------------- | +| `string` | `url` | Link of the file where the latest version is stored. | #### Usage -~~~ c# +```c# using PeyrSharp.Env; private async void Main() { - string lastVersion = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/Leo-Corporation/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt"); + string lastVersion = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/DevyusCode/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt"); // lastVersion would be equal to the content of this text files } -~~~ +``` ### IsAvailable(currentVersion, remoteVersion) + #### Definition + Compares two versions. Returns a `bool`. ::: info @@ -57,23 +63,23 @@ It is recommended to use this method with the [`GetLastVersionAsync()`](#getlast #### Arguments -| Type | Name | Meaning | -|------------ |------------ |----------------------------------------------------------- | -| `string` | `currentVersion` | The current version of the app. | -| `string` | `removeVersion` | The latest version, stored remotely. | +| Type | Name | Meaning | +| -------- | ---------------- | ------------------------------------ | +| `string` | `currentVersion` | The current version of the app. | +| `string` | `removeVersion` | The latest version, stored remotely. | #### Usage -~~~ c# +```c# using PeyrSharp.Env; private async void Main() { string current = "1.0"; - string last = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/Leo-Corporation/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt"); + string last = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/DevyusCode/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt"); Console.WriteLine(Update.IsAvailable(current, last) ? "Updates are available." : "You are up-to-date."); } -~~~ \ No newline at end of file +``` diff --git a/Documentation/package.json b/Documentation/package.json index 41acb37..3dfe9eb 100644 --- a/Documentation/package.json +++ b/Documentation/package.json @@ -10,7 +10,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/Leo-Corporation/PeyrSharp.git" + "url": "git+https://github.com/DevyusCode/PeyrSharp.git" }, "keywords": [ "docs" @@ -18,9 +18,9 @@ "author": "Devyus + contributors", "license": "MIT", "bugs": { - "url": "https://github.com/Leo-Corporation/PeyrSharp/issues" + "url": "https://github.com/DevyusCode/PeyrSharp/issues" }, - "homepage": "https://github.com/Leo-Corporation/PeyrSharp#readme", + "homepage": "https://github.com/DevyusCode/PeyrSharp#readme", "devDependencies": { "vitepress": "^1.0.0-alpha.19", "vue": "^3.2.40" diff --git a/NUGET_README.md b/NUGET_README.md index 85f9fdd..24da649 100644 --- a/NUGET_README.md +++ b/NUGET_README.md @@ -1,24 +1,28 @@ ![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget) -![GitHub contributors](https://img.shields.io/github/contributors/Leo-Corporation/PeyrSharp) -![GitHub issues](https://img.shields.io/github/issues/Leo-Corporation/PeyrSharp) -![GitHub](https://img.shields.io/github/license/Leo-Corporation/PeyrSharp) -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp) +![GitHub contributors](https://img.shields.io/github/contributors/DevyusCode/PeyrSharp) +![GitHub issues](https://img.shields.io/github/issues/DevyusCode/PeyrSharp) +![GitHub](https://img.shields.io/github/license/DevyusCode/PeyrSharp) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp) ![Nuget](https://img.shields.io/nuget/dt/PeyrSharp) # PeyrSharp -A C# library designed to make developers' job easier. -[View documentation »](https://peyrsharp.leocorporation.dev/) · [Report Bug](https://github.com/Leo-Corporation/PeyrSharp/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+) · [Request Feature](https://github.com/Leo-Corporation/PeyrSharp/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BEnhancement%5D+) +A C# library designed to make developers' job easier. +[View documentation »](https://peyrsharp.leocorporation.dev/) · [Report Bug](https://github.com/DevyusCode/PeyrSharp/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+) · [Request Feature](https://github.com/DevyusCode/PeyrSharp/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BEnhancement%5D+) ## Introduction + ### The roots + In March 2020, we published LeoCorpLibrary, which was also a C# library that contains useful methods. When we started the development of it, we didn't know where the project will go yet. Over the releases, we've added more and more methods and new features. However, the meaning and the purpose of LeoCorpLibrary was becoming less clear for everyone; it was becoming a mess. This is why we decided to rather not release v5, but instead, we decided to make a brand new .NET Library, PeyrSharp. ### Our next product + PeyrSharp is a C# written library designed to make developers' life easier. We've all written code that we wish we hadn't. PeyrSharp is here to respond to this need; by implementing useful methods in various domains: Mathematics, Web/HTTP requests, unit converters, extensions, environment-related operations, and more! ## Modules + PeyrSharp is divided in multiple packages: **PeyrSharp**, the main package, that contains all of the followings: @@ -33,15 +37,13 @@ PeyrSharp is divided in multiple packages: - Crypt **PeyrSharp.Env**, methods related to the file system and to the current execution environment. - - FileSys - Logger - Update -- System +- System **PeyrSharp.Enums**, all enumerations used by PeyrSharp - - WindowsVersion - TimeUnits @@ -53,44 +55,49 @@ PeyrSharp is divided in multiple packages: - PasswordStrength **PeyrSharp.Exceptions**, all exceptions used by PeyrSharp - + - RGBInvalidValueException - HEXInvalidValueException - InvalidGuidLengthException **PeyrSharp.Extensions**, extension methods, that extends basic types, such as `string`, `int`, `double` or arrays (`T[]`). - + - String - Int - Double - Array (`T[]`) **PeyrSharp.UiHelpers**, methods related to Windows Forms or to the Windows Presentation Framework (WPF). - + - WinForms - Screen - WPF ## Compatibility + ### Platforms + Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platforms. -| Package/Platform | Windows | macOS | Linux + others | -|------------------ |--------- |------- |---------------- | -| Core | ✅ | ✅ | ✅ | -| Env | ✅ | ⚠️ | ⚠️ | -| Enums | ✅ | ✅ | ✅ | -| Exceptions | ✅ | ✅ | ✅ | -| Extensions | ✅ | ✅ | ✅ | -| UiHelpers | ✅ | ❌ | ❌ | +| Package/Platform | Windows | macOS | Linux + others | +| ---------------- | ------- | ----- | -------------- | +| Core | ✅ | ✅ | ✅ | +| Env | ✅ | ⚠️ | ⚠️ | +| Enums | ✅ | ✅ | ✅ | +| Exceptions | ✅ | ✅ | ✅ | +| Extensions | ✅ | ✅ | ✅ | +| UiHelpers | ✅ | ❌ | ❌ | Caption: + - ✅ Full Support - ⚠️ Partial Support - ❌ Unsupported platform ### Frameworks + PeyrSharp is available in the following frameworks + - .NET 5 - .NET 6 - .NET 7 (soon) @@ -98,31 +105,37 @@ PeyrSharp is available in the following frameworks > Note: .NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported. ## Documentation + ### Branches + There are two branches: -| Name | Release | Description | -| :--: | :-----: | :---------: | -| `main` | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp) | Stable versions | -| `vNext` | ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp?include_prereleases) | Next version of PeyrSharp (unstable) | +| Name | Release | Description | +| :-----: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------: | +| `main` | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp) | Stable versions | +| `vNext` | ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp?include_prereleases) | Next version of PeyrSharp (unstable) | > Note: Other branches can also - of course - exists. ## Contribute + Here's what you'll need to contribute to this project: + - Visual Studio 2022 with: - - .NET Desktop Development - - Git + - .NET Desktop Development + - Git - .NET - - .NET 5 (SDK + runtime) - - .NET 6 (SDK + runtime) - - .NET 7 (SDK + runtime) -- (*optional*) NuGet + - .NET 5 (SDK + runtime) + - .NET 6 (SDK + runtime) + - .NET 7 (SDK + runtime) +- (_optional_) NuGet ## Badge -~~~ md + +```md ![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget) -~~~ +``` ## License -Project under the [MIT](https://github.com/Leo-Corporation/PeyrSharp/blob/main/LICENSE) license. + +Project under the [MIT](https://github.com/DevyusCode/PeyrSharp/blob/main/LICENSE) license. diff --git a/PeyrSharp.Core/PeyrSharp.Core.csproj b/PeyrSharp.Core/PeyrSharp.Core.csproj index 9c8b3a8..996512c 100644 --- a/PeyrSharp.Core/PeyrSharp.Core.csproj +++ b/PeyrSharp.Core/PeyrSharp.Core.csproj @@ -9,7 +9,7 @@ Core methods and features of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp + https://github.com/DevyusCode/PeyrSharp git math;password;guid;generators;core;geometry logo.png @@ -35,4 +35,4 @@ - + \ No newline at end of file diff --git a/PeyrSharp.Enums/PeyrSharp.Enums.csproj b/PeyrSharp.Enums/PeyrSharp.Enums.csproj index 02eb772..719ecf9 100644 --- a/PeyrSharp.Enums/PeyrSharp.Enums.csproj +++ b/PeyrSharp.Enums/PeyrSharp.Enums.csproj @@ -1,36 +1,36 @@  - - net5.0;net6.0;net7.0 - disable - enable - PeyrSharp.Enums - Devyus - Enumerations of PeyrSharp. - © 2023 - https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp - enums;c-sharp;dotnet;vb;peyrsharp;leo corp - 1.5.0.2304 - True - logo.png - NUGET_README.md - True - MIT - git - - Added the ``LogLevel`` enumeration (#90) - - + + net5.0;net6.0;net7.0 + disable + enable + PeyrSharp.Enums + Devyus + Enumerations of PeyrSharp. + © 2023 + https://peyrsharp.leocorporation.dev/ + https://github.com/DevyusCode/PeyrSharp + enums;c-sharp;dotnet;vb;peyrsharp;leo corp + 1.5.0.2304 + True + logo.png + NUGET_README.md + True + MIT + git + - Added the ``LogLevel`` enumeration (#90) + + - - - True - \ - - - True - \ - - + + + True + \ + + + True + \ + + - + \ No newline at end of file diff --git a/PeyrSharp.Env/PeyrSharp.Env.csproj b/PeyrSharp.Env/PeyrSharp.Env.csproj index 668ff56..20de8eb 100644 --- a/PeyrSharp.Env/PeyrSharp.Env.csproj +++ b/PeyrSharp.Env/PeyrSharp.Env.csproj @@ -9,7 +9,7 @@ Environment-related methods of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp + https://github.com/DevyusCode/PeyrSharp git logger;file;env;file-system;update-system;windows;system logo.png @@ -17,7 +17,7 @@ MIT True - Added the possibility to format the logged message (#89) -- Added the possibility to generate a log message depending on the `LogLevel` (#91) + - Added the possibility to generate a log message depending on the `LogLevel` (#91) @@ -32,6 +32,6 @@ - + - + \ No newline at end of file diff --git a/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj b/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj index f9dc861..33ab3b9 100644 --- a/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj +++ b/PeyrSharp.Exceptions/PeyrSharp.Exceptions.csproj @@ -11,7 +11,7 @@ Exceptions of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp + https://github.com/DevyusCode/PeyrSharp logo.png NUGET_README.md exceptions;c-sharp;dotnet;vb;peyrsharp;leo corp @@ -31,4 +31,4 @@ - + \ No newline at end of file diff --git a/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj b/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj index 95e465e..dac4c96 100644 --- a/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj +++ b/PeyrSharp.Extensions/PeyrSharp.Extensions.csproj @@ -9,7 +9,7 @@ Extensions methods of PeyrSharp. © 2023 https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp + https://github.com/DevyusCode/PeyrSharp git extension;extends;string;double;int;peyrsharp;crypt;converters;array logo.png @@ -17,8 +17,8 @@ MIT True - Added Mean() extension method for int[] and double[] (#92) -- Added Median() extension method for int[] and double[] (#93) -- Added Mode() extension method for int[] and double[] (#94) + - Added Median() extension method for int[] and double[] (#93) + - Added Mode() extension method for int[] and double[] (#94) @@ -33,7 +33,7 @@ - + - + \ No newline at end of file diff --git a/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj b/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj index 278db11..00e1008 100644 --- a/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj +++ b/PeyrSharp.UiHelpers/PeyrSharp.UiHelpers.csproj @@ -1,40 +1,41 @@  - - net5.0-windows;net6.0-windows;net7.0-windows - disable - enable - true - true - True - PeyrSharp.UiHelpers - 1.5.0.2304 - Devyus - Useful helpers for Windows Forms and Windows Presentation Framework. - © 2023 - https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp - ui-helpers;c-sharp;dotnet;vb;peyrsharp;leo corp;wpf;windows-forms;win-forms;ui;windows - logo.png - NUGET_README.md - MIT - True - - + + net5.0-windows;net6.0-windows;net7.0-windows + disable + enable + true + true + True + PeyrSharp.UiHelpers + 1.5.0.2304 + Devyus + Useful helpers for Windows Forms and Windows Presentation Framework. + © 2023 + https://peyrsharp.leocorporation.dev/ + https://github.com/DevyusCode/PeyrSharp + ui-helpers;c-sharp;dotnet;vb;peyrsharp;leo + corp;wpf;windows-forms;win-forms;ui;windows + logo.png + NUGET_README.md + MIT + True + + - - - True - \ - - - True - \ - - + + + True + \ + + + True + \ + + - - - + + + - + \ No newline at end of file diff --git a/PeyrSharp/PeyrSharp.csproj b/PeyrSharp/PeyrSharp.csproj index 08ac79a..cf5243e 100644 --- a/PeyrSharp/PeyrSharp.csproj +++ b/PeyrSharp/PeyrSharp.csproj @@ -9,19 +9,20 @@ © 2023 A C# library designed to make developers' job easier. https://peyrsharp.leocorporation.dev/ - https://github.com/Leo-Corporation/PeyrSharp + https://github.com/DevyusCode/PeyrSharp git - math;password;guid;generators;core;geometry;environment;extensions;enumerations;exceptions;ui-helpers + + math;password;guid;generators;core;geometry;environment;extensions;enumerations;exceptions;ui-helpers logo.png NUGET_README.md MIT True - Added the possibility to format the logged message (#89) -- Added the LogLevel enumeration (#90) -- Added the possibility to generate a log message depending on the LogLevel (#91) -- Added Mean() extension method for int[] and double[] (#92) -- Added Median() extension method for int[] and double[] (#93) -- Added Mode() extension method for int[] and double[] (#94) + - Added the LogLevel enumeration (#90) + - Added the possibility to generate a log message depending on the LogLevel (#91) + - Added Mean() extension method for int[] and double[] (#92) + - Added Median() extension method for int[] and double[] (#93) + - Added Mode() extension method for int[] and double[] (#94) @@ -36,12 +37,13 @@ - - - - - - + + + + + + - + \ No newline at end of file diff --git a/README.md b/README.md index d6a2da9..533cfac 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ ![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget) -![GitHub contributors](https://img.shields.io/github/contributors/Leo-Corporation/PeyrSharp) -![GitHub issues](https://img.shields.io/github/issues/Leo-Corporation/PeyrSharp) -![GitHub](https://img.shields.io/github/license/Leo-Corporation/PeyrSharp) -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp) +![GitHub contributors](https://img.shields.io/github/contributors/DevyusCode/PeyrSharp) +![GitHub issues](https://img.shields.io/github/issues/DevyusCode/PeyrSharp) +![GitHub](https://img.shields.io/github/license/DevyusCode/PeyrSharp) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp) ![Nuget](https://img.shields.io/nuget/dt/PeyrSharp)

- + Logo @@ -18,9 +18,9 @@
View documentation »
- Report Bug + Report Bug · - Request Feature + Request Feature · NuGet @@ -28,13 +28,17 @@

## Introduction + ### The roots + In March 2020, we published LeoCorpLibrary, which was also a C# library that contains useful methods. When we started the development of it, we didn't know where the project will go yet. Over the releases, we've added more and more methods and new features. However, the meaning and the purpose of LeoCorpLibrary was becoming less clear for everyone; it was becoming a mess. This is why we decided to rather not release v5, but instead, we decided to make a brand new .NET Library, PeyrSharp. ### Our next product + PeyrSharp is a C# written library designed to make developers' life easier. We've all written code that we wish we hadn't. PeyrSharp is here to respond to this need; by implementing useful methods in various domains: Mathematics, Web/HTTP requests, unit converters, extensions, environment-related operations, and more! ## Modules + PeyrSharp is divided in multiple packages: **PeyrSharp**, the main package, that contains all of the followings: @@ -79,7 +83,7 @@ PeyrSharp is divided in multiple packages: - PasswordPresets - PasswordStrength - +
@@ -116,25 +120,30 @@ PeyrSharp is divided in multiple packages:
## Compatibility + ### Platforms + Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platforms. -| Package/Platform | Windows | macOS | Linux + others | -|------------------ |--------- |------- |---------------- | -| Core | ✅ | ✅ | ✅ | -| Env | ✅ | ⚠️ | ⚠️ | -| Enums | ✅ | ✅ | ✅ | -| Exceptions | ✅ | ✅ | ✅ | -| Extensions | ✅ | ✅ | ✅ | -| UiHelpers | ✅ | ❌ | ❌ | +| Package/Platform | Windows | macOS | Linux + others | +| ---------------- | ------- | ----- | -------------- | +| Core | ✅ | ✅ | ✅ | +| Env | ✅ | ⚠️ | ⚠️ | +| Enums | ✅ | ✅ | ✅ | +| Exceptions | ✅ | ✅ | ✅ | +| Extensions | ✅ | ✅ | ✅ | +| UiHelpers | ✅ | ❌ | ❌ | Caption: + - ✅ Full Support - ⚠️ Partial Support - ❌ Unsupported platform ### Frameworks + PeyrSharp is available in the following frameworks + - .NET 5 - .NET 6 - .NET 7 (soon) @@ -142,35 +151,42 @@ PeyrSharp is available in the following frameworks > Note: .NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported. ## Documentation + ### Website + PeyrSharp has an [official website](https://peyrsharp.leocorporation.dev/) where you can find its documentation. ### Branches + There are two branches: -| Name | Release | Description | -| :--: | :-----: | :---------: | -| `main` | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp) | Stable versions | -| `vNext` | ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Leo-Corporation/PeyrSharp?include_prereleases) | Next version of PeyrSharp (unstable) | -| `doc` | N/A | The branch used to maintain the documentation. | +| Name | Release | Description | +| :-----: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------: | +| `main` | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp) | Stable versions | +| `vNext` | ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/DevyusCode/PeyrSharp?include_prereleases) | Next version of PeyrSharp (unstable) | +| `doc` | N/A | The branch used to maintain the documentation. | > Note: Other branches can also - of course - exists. ## Contribute + Here's what you'll need to contribute to this project: + - Visual Studio 2022 with: - - .NET Desktop Development - - Git + - .NET Desktop Development + - Git - .NET - - .NET 5 (SDK + runtime) - - .NET 6 (SDK + runtime) - - .NET 7 (SDK + runtime) -- (*optional*) NuGet + - .NET 5 (SDK + runtime) + - .NET 6 (SDK + runtime) + - .NET 7 (SDK + runtime) +- (_optional_) NuGet ## Badge -~~~ md + +```md ![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget) -~~~ +``` ## License -Project under the [MIT](https://github.com/Leo-Corporation/PeyrSharp/blob/main/LICENSE) license. + +Project under the [MIT](https://github.com/DevyusCode/PeyrSharp/blob/main/LICENSE) license. diff --git a/docs/404.html b/docs/404.html index 1385b68..6b8731b 100644 --- a/docs/404.html +++ b/docs/404.html @@ -199,7 +199,7 @@ > PAGE NOT FOUND '{"core_converters_energies.md":"30b4c932","core_maths_percentages.md":"1feda028","index.md":"25b4b320","core.md":"04b61d38","core_converters_distances.md":"f8ae93d3","core_converters_colors_rgb.md":"ae0ad331","core_converters_masses.md":"e2f9874b","core_converters_colors_hsv.md":"70b2079b","core_converters_temperatures.md":"4ef5c821","core_converters_volumes.md":"5be7a6e3","core_maths_stats.md":"e317b135","core_maths_geometry_diamond.md":"b6c2fd0a","core_guid.md":"a2935b56","core_maths.md":"386c26b1","core_password.md":"a6d4fc6d","core_maths_geometry_cone.md":"753c86c5","core_converters_storage.md":"7f68946a","core_maths_geometry_circle.md":"e8a89d45","core_internet.md":"45eeb599","core_maths_geometry.md":"878759b2","core_maths_trigonometry.md":"6cc4354b","core_maths_geometry_sphere.md":"2244644b","core_maths_geometry_triangle.md":"b66783c6","core_converters.md":"e3a58f3d","core_converters_time.md":"37562baf","ui-helpers_screen.md":"b13fbb11","core_maths_geometry_hexagon.md":"198cc7a3","reference.md":"169cc3bf","ui-helpers_winforms.md":"cb60597a","core_maths_proba.md":"8b031e1a","core_maths_geometry_pyramid.md":"024dce70","ui-helpers_wpf.md":"6d4e4bdd","core_converters_colors_hex.md":"8310aa19","core_crypt.md":"6d77ba69","core_converters_angle.md":"628bef10","env_update.md":"23d652b4","env_system.md":"5701262b","core_maths_geometry_rectangle.md":"6550635b","extensions_int.md":"e3682c4d","core_maths_algebra.md":"4877489b","env_logger.md":"9aea516b","core_guid-options.md":"5637bd7b","intro.md":"ecc1f751","extensions_array.md":"76dbee0c","ui-helpers.md":"1cb72d0a","extensions.md":"617fb60c","core_maths_geometry_cube.md":"16564995","env.md":"94b1d70a","enumerations.md":"3eb0b411","extensions_double.md":"b0e69aa8","get-started.md":"d3385ee5","core_maths_geometry_cylinder.md":"e4bd7953","env_filesys.md":"396c4c37","extensions_string.md":"0660789f","core_converters_speeds.md":"e518b142","exceptions.md":"bd52d342"}' ); __VP_SITE_DATA__ = JSON.parse( - '{"lang":"en-US","dir":"ltr","title":"PeyrSharp","description":"A C# library designed to make developers\' job easier.","base":"/","head":[],"appearance":true,"themeConfig":{"nav":[{"text":"Guide","link":"/get-started"},{"text":"Reference","link":"/reference"}],"repo":"Leo-Corporation/PeyrSharp","docsDir":"documentation","docsBranch":"main","editLink":{"pattern":"https://github.com/Leo-Corporation/PeyrSharp/edit/main/Documentation/:path","text":"Edit this page on GitHub"},"footer":{"message":"Released under the MIT License.","copyright":"Copyright © 2023 Devyus"},"algolia":{"appId":"JVAJ1JZ6HO","apiKey":"0ef6a29a84fc5698ce54fde4381bf281","indexName":"peyrsharp"},"socialLinks":[{"icon":"github","link":"https://github.com/Leo-Corporation/PeyrSharp"},{"icon":"twitter","link":"https://twitter.com/LeoCorpNews"},{"icon":"youtube","link":"https://www.youtube.com/channel/UC283Dtf6EJ8eKfRoo0ISmqg"}],"outline":[1,3],"sidebar":{"/core/":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}],"core":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}],"get-started":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"/ui-helpers/":[{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"ui-helpers":[{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"/env/":[{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]}],"env":[{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]}],"/extensions/":[{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]}],"/extension":[{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]}],"reference":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"enumerations":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"exceptions":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}]}},"locales":{},"scrollOffset":90,"cleanUrls":false}' + '{"lang":"en-US","dir":"ltr","title":"PeyrSharp","description":"A C# library designed to make developers\' job easier.","base":"/","head":[],"appearance":true,"themeConfig":{"nav":[{"text":"Guide","link":"/get-started"},{"text":"Reference","link":"/reference"}],"repo":"DevyusCode/PeyrSharp","docsDir":"documentation","docsBranch":"main","editLink":{"pattern":"https://github.com/DevyusCode/PeyrSharp/edit/main/Documentation/:path","text":"Edit this page on GitHub"},"footer":{"message":"Released under the MIT License.","copyright":"Copyright © 2023 Devyus"},"algolia":{"appId":"JVAJ1JZ6HO","apiKey":"0ef6a29a84fc5698ce54fde4381bf281","indexName":"peyrsharp"},"socialLinks":[{"icon":"github","link":"https://github.com/DevyusCode/PeyrSharp"},{"icon":"twitter","link":"https://twitter.com/LeoCorpNews"},{"icon":"youtube","link":"https://www.youtube.com/channel/UC283Dtf6EJ8eKfRoo0ISmqg"}],"outline":[1,3],"sidebar":{"/core/":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}],"core":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}],"get-started":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"/ui-helpers/":[{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"ui-helpers":[{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"/env/":[{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]}],"env":[{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]}],"/extensions/":[{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]}],"/extension":[{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]}],"reference":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"enumerations":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}],"exceptions":[{"text":"Core","collapsed":false,"items":[{"text":"Converters","collapsed":false,"items":[{"text":"Home","link":"/core/converters"},{"text":"Angle","link":"/core/converters/angle"},{"text":"Colors","collapsed":true,"items":[{"text":"RGB","link":"/core/converters/colors/rgb"},{"text":"HEX","link":"/core/converters/colors/hex"},{"text":"HSV","link":"/core/converters/colors/hsv"}]},{"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"},{"text":"Temperatures","link":"/core/converters/temperatures"},{"text":"Time","link":"/core/converters/time"},{"text":"Volumes","link":"/core/converters/volumes"}]},{"text":"Crypt","collapsed":false,"items":[{"text":"Crypt","link":"/core/crypt"}]},{"text":"Guid","collapsed":false,"items":[{"text":"GuidGen","link":"/core/guid"},{"text":"GuidOptions","link":"/core/guid-options"}]},{"text":"Internet","collapsed":false,"items":[{"text":"Internet","link":"/core/internet"}]},{"text":"Maths","collapsed":false,"items":[{"text":"Home","link":"/core/maths"},{"text":"Algebra","link":"/core/maths/algebra"},{"text":"Geometry","collapsed":true,"link":"/core/maths/geometry","items":[{"text":"Circle","link":"/core/maths/geometry/circle"},{"text":"Cone","link":"/core/maths/geometry/cone"},{"text":"Cube","link":"/core/maths/geometry/cube"},{"text":"Cylinder","link":"/core/maths/geometry/cylinder"},{"text":"Diamond","link":"/core/maths/geometry/diamond"},{"text":"Hexagon","link":"/core/maths/geometry/hexagon"},{"text":"Pyramid","link":"/core/maths/geometry/pyramid"},{"text":"Rectangle","link":"/core/maths/geometry/rectangle"},{"text":"Sphere","link":"/core/maths/geometry/sphere"},{"text":"Triangle","link":"/core/maths/geometry/triangle"}]},{"text":"Percentages","link":"/core/maths/percentages"},{"text":"Proba","link":"/core/maths/proba"},{"text":"Stats","link":"/core/maths/stats"},{"text":"Trigonometry","link":"/core/maths/trigonometry"}]},{"text":"Password","collapsed":false,"items":[{"text":"Password","link":"/core/password"}]}]},{"text":"Env","collapsed":false,"items":[{"text":"Home","link":"/env"},{"text":"FileSys","link":"/env/filesys"},{"text":"Logger","link":"/env/logger"},{"text":"Sys","link":"/env/system"},{"text":"Update","link":"/env/update"}]},{"text":"Enums","collapsed":false,"items":[{"text":"Home","link":"/enumerations"}]},{"text":"Exceptions","collapsed":false,"items":[{"text":"Home","link":"/exceptions"}]},{"text":"Extensions","collapsed":false,"items":[{"text":"Home","link":"/extensions"},{"text":"Array","link":"/extensions/array"},{"text":"Double","link":"/extensions/double"},{"text":"Int","link":"/extensions/int"},{"text":"String","link":"/extensions/string"}]},{"text":"UiHelpers","collapsed":false,"items":[{"text":"Home","link":"/ui-helpers"},{"text":"Screen","link":"/ui-helpers/screen"},{"text":"WinForms","link":"/ui-helpers/winforms"},{"text":"WPF","link":"/ui-helpers/wpf"}]}]}},"locales":{},"scrollOffset":90,"cleanUrls":false}' ); diff --git a/docs/assets/env_update.md.23d652b4.js b/docs/assets/env_update.md.23d652b4.js index a4108d9..d7b8719 100644 --- a/docs/assets/env_update.md.23d652b4.js +++ b/docs/assets/env_update.md.23d652b4.js @@ -1,8 +1,14 @@ -import{_ as s,c as a,o as e,Q as t}from"./chunks/framework.7addaa9c.js";const F=JSON.parse('{"title":"Update","description":"","frontmatter":{},"headers":[],"relativePath":"env/update.md","lastUpdated":1673088608000}'),n={name:"env/update.md"},o=t(`

Update

This page is about the Update class available in PeyrSharp.Env. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Update class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

GetLastVersionAsync(url)

Definition

Downloads the content of remote file as string. The remote file should contain the last version text. Do not provide the URL of an HTML page.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlLink of the file where the latest version is stored.

Usage

c#
using PeyrSharp.Env;
+import { _ as s, c as a, o as e, Q as t } from "./chunks/framework.7addaa9c.js";
+const F = JSON.parse(
+    '{"title":"Update","description":"","frontmatter":{},"headers":[],"relativePath":"env/update.md","lastUpdated":1673088608000}'
+  ),
+  n = { name: "env/update.md" },
+  o = t(
+    `

Update

This page is about the Update class available in PeyrSharp.Env. You can find here all of its methods.

INFO

This class is static.

Compatibility

The Update class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:

Package/PlatformWindowsmacOSLinux + others
Env
Framework.NET 5.NET 6.NET 7
Env

WARNING

Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.

Methods

GetLastVersionAsync(url)

Definition

Downloads the content of remote file as string. The remote file should contain the last version text. Do not provide the URL of an HTML page.

INFO

This method is asynchronous and awaitable.

Arguments

TypeNameMeaning
stringurlLink of the file where the latest version is stored.

Usage

c#
using PeyrSharp.Env;
 
 private async void Main()
 {
-    string lastVersion = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/Leo-Corporation/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt");
+    string lastVersion = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/DevyusCode/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt");
     // lastVersion would be equal to the content of this text files
 }
 

IsAvailable(currentVersion, remoteVersion)

Definition

Compares two versions. Returns a bool.

INFO

It is recommended to use this method with the GetLastVersionAsync() one.

Arguments

TypeNameMeaning
stringcurrentVersionThe current version of the app.
stringremoveVersionThe latest version, stored remotely.

Usage

c#
using PeyrSharp.Env;
@@ -10,10 +16,18 @@ import{_ as s,c as a,o as e,Q as t}from"./chunks/framework.7addaa9c.js";const F=
 private async void Main()
 {
     string current = "1.0";
-    string last = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/Leo-Corporation/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt");
+    string last = await Update.GetLastVersionAsync("https://raw.githubusercontent.com/DevyusCode/LeoCorp-Docs/master/Liens/Update%20System/LABS%20Experimental%20Console/version.txt");
 
     Console.WriteLine(Update.IsAvailable(current, last)
         ? "Updates are available."
         : "You are up-to-date.");
 }
-
`,24),l=[o];function p(r,c,i,d,h,y){return e(),a("div",null,l)}const u=s(n,[["render",p]]);export{F as __pageData,u as default}; +
`, + 24 + ), + l = [o]; +function p(r, c, i, d, h, y) { + return e(), a("div", null, l); +} +const u = s(n, [["render", p]]); +export { F as __pageData, u as default }; diff --git a/docs/core.html b/docs/core.html index b5966a6..bac4cdf 100644 --- a/docs/core.html +++ b/docs/core.html @@ -209,7 +209,7 @@ >