404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
This page is about the PeyrSharp.Core module.
The PeyrSharp.Core module is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
The Core namespace contains other namespaces:
This page is about the PeyrSharp.Core module.
The PeyrSharp.Core module is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
The Core namespace contains other namespaces:
This page is about the Converters namespace available in PeyrSharp.Core. You can find here all of its classes.
The Converters namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
This page is about the Converters namespace available in PeyrSharp.Core. You can find here all of its classes.
The Converters namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
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.
The Angle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts degrees to radians. Returns a double value.
| Type | Name | Meaning |
|---|---|---|
double | degrees | Number of degrees to convert. |
using PeyrSharp.Core.Converters;
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const b=JSON.parse('{"title":"Angle","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/angle.md","filePath":"core/converters/angle.md","lastUpdated":1666626451000}'),o={name:"core/converters/angle.md"},n=s(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
DegreesToRadians(degrees)
Definition
Converts degrees to radians. Returns a double value.
Arguments
Type Name Meaning 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
Type Name Meaning doubleradiansNumber of radians to convert.
Usage
c#using PeyrSharp.Core.Converters;
double deg = Angle.RadiansToDegrees(1.2);
-// deg = 68.7549354
`,21),r=[n];function l(d,i,c,p,h,g){return t(),a("div",null,r)}const m=e(o,[["render",l]]);export{b as __pageData,m as default};
+// deg = 68.7549354This page is about the HEX class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.
The HEX class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a hexadecimal class from a hexadecimal value.
| Type | Name | Meaning |
|---|---|---|
string | hex | The hexadecimal value (with or without #). |
WARNING
If you specify a non-hexadecimal value, a HEXInvalidValueException will be thrown.
using PeyrSharp.Core.Converters;
+import{_ as a,o as e,c as s,R as o}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"HEX","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/colors/hex.md","filePath":"core/converters/colors/hex.md","lastUpdated":1666628903000}'),t={name:"core/converters/colors/hex.md"},n=o(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Constructors
HEX(hex)
Initializes a hexadecimal class from a hexadecimal value.
Arguments
Type Name Meaning 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;
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;
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;
-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.
`,33),l=[n];function r(c,p,i,h,d,u){return s(),e("div",null,l)}const F=a(t,[["render",r]]);export{C as __pageData,F as default};
+HSV hsv = new HEX("#E1077B").ToHsv();public string Value { get; init; }The Value property contains the hexadecimal value of the HEX color. You can only get this property.
This page is about the HSV class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.
The HSV class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a HSV color from its hue, saturation, and value.
| Type | Name | Meaning |
|---|---|---|
int | hue | The Hue of the color. |
int | saturation | The saturation percentage. |
int | value | The value/brightness percentage. |
using PeyrSharp.Core.Converters;
+import{_ as a,o as e,c as t,R as o}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"HSV","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/colors/hsv.md","filePath":"core/converters/colors/hsv.md","lastUpdated":1666628914000}'),s={name:"core/converters/colors/hsv.md"},n=o(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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.
`,26),r=[n];function l(i,c,p,d,h,u){return t(),e("div",null,r)}const D=a(s,[["render",l]]);export{C as __pageData,D as default};
+HSV hsv = new(50, 75, 100);public int Hue { get; init; }The Hue property contains the hue of the HSV color. You can only get this property.
public int Saturation { get; init; }The Value property contains the saturation percentage of the HSV color. You can only get this property.
public int Value { get; init; }The Value property contains the value/brightness percentage of the HSV color. You can only get this property.
This page is about the RGB class available in PeyrSharp.Core.Converters. You can find here all of its methods and properties.
The RGB class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a RGB class from a System.Drawing.Color. Returns a RGB class.
| Type | Name | Meaning |
|---|---|---|
Color | color | The RGB color. |
using PeyrSharp.Core.Converters;
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.8e8e72cd.js";const u=JSON.parse('{"title":"RGB","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/colors/rgb.md","filePath":"core/converters/colors/rgb.md","lastUpdated":1666628921000}'),t={name:"core/converters/colors/rgb.md"},n=o(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning 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;
@@ -7,4 +7,4 @@ import{_ as a,c as s,o as e,R as o}from"./chunks/framework.bdd825cc.js";const u=
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;
-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.
`,41),r=[n];function l(c,p,i,d,h,C){return e(),s("div",null,r)}const F=a(t,[["render",l]]);export{u as __pageData,F as default};
+HSV hsv = new RGB(255, 0, 0).ToHsv();public Color Color { get; init; }The Color property contains the RGB color as a System.Drawing.Color. You can only get this property.
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.
The Distances class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts miles to kilometers. Returns a double value.
| Type | Name | Meaning |
|---|---|---|
double | miles | Number of mile(s) to convert. |
using PeyrSharp.Core.Converters;
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const y=JSON.parse('{"title":"Distances","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/distances.md","filePath":"core/converters/distances.md","lastUpdated":1666511609000}'),o={name:"core/converters/distances.md"},n=s(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
MilesToKm(miles)
Definition
Converts miles to kilometers. Returns a double value.
Arguments
Type Name Meaning 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
Type Name Meaning doublekilometersNumber of kilometers(s) to convert.
Usage
c#using PeyrSharp.Core.Converters;
@@ -10,4 +10,4 @@ import{_ as e,c as a,o as t,R as s}from"./chunks/framework.bdd825cc.js";const y=
// meters = 3.657599994440448
MetersToFeet(meters)
Definition
Converts meters to feet. Returns a double value.
Arguments
Type Name Meaning doublemetersNumber of meters to convert.
Usage
c#using PeyrSharp.Core.Converters;
double feet = Distances.MetersToFeet(3.657599994440448);
-// feet = 12
`,35),l=[n];function r(i,c,d,p,h,m){return t(),a("div",null,l)}const b=e(o,[["render",r]]);export{y as __pageData,b as default};
+// feet = 12This page is about the Energies class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Energies class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts calories to joules.
| Type | Name | Meaning |
|---|---|---|
double | calories | The amount of energy in calories to be converted. |
The equivalent amount of energy in joules.
using PeyrSharp.Core.Converters;
+import{_ as e,o as a,c as s,R as o}from"./chunks/framework.8e8e72cd.js";const y=JSON.parse('{"title":"Energies","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/energies.md","filePath":"core/converters/energies.md","lastUpdated":1678016186000}'),t={name:"core/converters/energies.md"},n=o(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
CaloriesToJoules(calories)
Definition
Converts calories to joules.
Arguments
Type Name Meaning doublecaloriesThe amount of energy in calories to be converted.
Returns
The equivalent amount of energy in joules.
Usage
c#using PeyrSharp.Core.Converters;
double calories = 100.0;
double joules = Energies.CaloriesToJoules(calories);
JoulesToCalories(joules)
Definition
Converts joules to calories.
Arguments
Type Name Meaning 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);
`,25),l=[n];function r(i,c,p,d,h,u){return s(),a("div",null,l)}const b=e(t,[["render",r]]);export{y as __pageData,b as default};
+double calories = Energies.JoulesToCalories(joules);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.
The Masses class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts pounds to kilograms. Returns a double value.
| Type | Name | Meaning |
|---|---|---|
double | pounds | Number of pounds to convert. |
using PeyrSharp.Core.Converters;
+import{_ as a,o as s,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const g=JSON.parse('{"title":"Masses","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/masses.md","filePath":"core/converters/masses.md","lastUpdated":1666511609000}'),o={name:"core/converters/masses.md"},n=t(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
PoundsToKilograms(pounds)
Definition
Converts pounds to kilograms. Returns a double value.
Arguments
Type Name Meaning 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
Type Name Meaning doublekilogramsNumber of kilograms to convert.
Usage
c#using PeyrSharp.Core.Converters;
double pounds = Masses.KilogramsToPounds(25);
-// pounds = 55.115565499999995
`,21),r=[n];function l(d,i,c,p,h,u){return e(),s("div",null,r)}const b=a(o,[["render",l]]);export{g as __pageData,b as default};
+// pounds = 55.115565499999995This page is about the Speeds class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Speeds class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts knots to kilometers per hour.
| Type | Name | Meaning |
|---|---|---|
double | knots | The speed in knots. |
The equivalent speed in kilometers per hour.
using PeyrSharp.Core.Converters;
+import{_ as e,o as s,c as a,R as o}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"Speeds","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/speeds.md","filePath":"core/converters/speeds.md","lastUpdated":1683446294000}'),n={name:"core/converters/speeds.md"},t=o(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
KnotsToKilometersPerHour(knots)
Definition
Converts knots to kilometers per hour.
Arguments
Type Name Meaning 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);
@@ -36,4 +36,4 @@ import{_ as e,c as s,o as a,R as o}from"./chunks/framework.bdd825cc.js";const F=
// kmPerHour = 1234.8
MachToMilesPerHour(mach)
Definition
Converts a speed in mach to miles per hour. Returns a double value.
Arguments
Type Name Meaning doublemachThe speed in mach.
Returns
A double representing the speed in miles per hour.
Usage
c#using PeyrSharp.Core.Converters;
double mph = Speeds.MachToMilesPerHour(0.8);
-// mph = 613.8153184
`,95),r=[t];function l(p,i,c,d,h,u){return a(),s("div",null,r)}const y=e(n,[["render",l]]);export{F as __pageData,y as default};
+// mph = 613.8153184This page is about the Storage class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Storage class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts a size (kb, mb, ...) to byte. Returns a double value.
INFO
This method can also be used in PeyrSharp.Extensions.
| Type | Name | Meaning |
|---|---|---|
double | value | The value to convert. |
StorageUnits | storageUnit | The unit of the value. (ex: kilobyte, gigabyte...) |
using PeyrSharp.Core.Converters;
+import{_ as a,o as e,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const b=JSON.parse('{"title":"Storage","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/storage.md","filePath":"core/converters/storage.md","lastUpdated":1683446294000}'),o={name:"core/converters/storage.md"},n=s(`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/Platform Windows macOS Linux + 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
Type Name Meaning doublevalueThe value to convert. StorageUnitsstorageUnitThe 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
Type Name Meaning doublevalueThe value to convert. StorageUnitsstorageUnitThe unit of the value. (ex: byte, gigabyte...)
Usage
c#using PeyrSharp.Core.Converters;
@@ -22,4 +22,4 @@ import{_ as a,c as e,o as t,R as s}from"./chunks/framework.bdd825cc.js";const b=
// bytes = 8
BytesToBits(n)
Definition
Converts a number of bytes to a number of bits. Returns a double value.
Arguments
Type Name Meaning doublenThe number of bytes to convert to bits.
Usage
c#using PeyrSharp.Core.Converters;
double bits = Storage.BytesToBits(1024);
-// bits = 8192
`,69),l=[n];function r(i,c,p,d,h,u){return t(),e("div",null,l)}const g=a(o,[["render",r]]);export{b as __pageData,g as default};
+// bits = 8192This page is about the Temperatures class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Temperatures class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts Celsius (°C) to Fahrenheit (°F). Returns a double value.
| Type | Name | Meaning |
|---|---|---|
double | celsius | Number of Celsius to convert. |
using PeyrSharp.Core.Converters;
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"Temperatures","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/temperatures.md","filePath":"core/converters/temperatures.md","lastUpdated":1666511987000}'),o={name:"core/converters/temperatures.md"},r=s(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning doublefahrenheitNumber of Fahrenheit to convert.
Usage
c#using PeyrSharp.Core.Converters;
double c = Temperatures.FahrenheitToCelsius(75);
-// c = 23.88888888888889
`,21),n=[r];function l(i,c,h,d,p,u){return t(),a("div",null,n)}const b=e(o,[["render",l]]);export{C as __pageData,b as default};
+// c = 23.88888888888889This page is about the Time class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Time class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
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.
| Type | Name | Meaning |
|---|---|---|
double | d | The time unit to convert. |
TimeUnits | timeUnits | The unit of the time. (ex: minutes, hours...) |
using PeyrSharp.Core.Converters;
+import{_ as e,o as s,c as a,R as t}from"./chunks/framework.8e8e72cd.js";const y=JSON.parse('{"title":"Time","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/time.md","filePath":"core/converters/time.md","lastUpdated":1670145438000}'),n={name:"core/converters/time.md"},o=t(`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/Platform Windows macOS Linux + 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
Type Name Meaning doubledThe time unit to convert. TimeUnitstimeUnitsThe unit of the time. (ex: minutes, hours...)
Usage
c#using PeyrSharp.Core.Converters;
using PeyrSharp.Enums;
double seconds = Time.ToSeconds(5, TimeUnits.Minutes);
@@ -19,4 +19,4 @@ import{_ as e,c as s,o as a,R as t}from"./chunks/framework.bdd825cc.js";const y=
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
Type Name Meaning 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
`,55),l=[o];function i(r,c,p,d,h,u){return a(),s("div",null,l)}const D=e(n,[["render",i]]);export{y as __pageData,D as default};
+// unix = 1670144268This page is about the Volumes class available in PeyrSharp.Core.Converters. You can find here all of its methods.
INFO
This class is static.
The Volumes class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Converts Cubic Meters (m³) to Litre (L). Returns a double value.
| Type | Name | Meaning |
|---|---|---|
double | m3 | Number of cubic meters to convert. |
using PeyrSharp.Core.Converters;
+import{_ as e,o as t,c as a,R as s}from"./chunks/framework.8e8e72cd.js";const b=JSON.parse('{"title":"Volumes","description":"","frontmatter":{},"headers":[],"relativePath":"core/converters/volumes.md","filePath":"core/converters/volumes.md","lastUpdated":1666513063000}'),o={name:"core/converters/volumes.md"},n=s(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning doublelitreNumber of litres to convert.
Usage
c#using PeyrSharp.Core.Converters;
double m3 = Volumes.LitreToM3(500);
-// m3 = 0.5
`,21),r=[n];function l(i,c,d,p,h,m){return a(),t("div",null,r)}const y=e(o,[["render",l]]);export{b as __pageData,y as default};
+// m3 = 0.5This page is about the Crypt class available in PeyrSharp.Core. You can find here all of its methods.
INFO
This class is static.
The Crypt class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Encrypts a string using AES encryption. Returns the encrypted content as a string as well.
| Type | Name | Meaning |
|---|---|---|
string | str | The text to encrypt. |
string | key | The encryption key. This is the same key that will be used to decrypt the text. |
using PeyrSharp.Core;
+import{_ as s,o as a,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"Crypt","description":"","frontmatter":{},"headers":[],"relativePath":"core/crypt.md","filePath":"core/crypt.md","lastUpdated":1666705294000}'),n={name:"core/crypt.md"},o=t(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
string text = "Hello, world!";
string encrypted = Crypt.EncryptAes(text, "password");
@@ -30,4 +30,4 @@ import{_ as s,c as a,o as e,R as t}from"./chunks/framework.bdd825cc.js";const F=
string encrypted = "AvuLd4LUxRU=";
string text = Crypt.Decrypt3Des(encrypted, "123");
-// text = Hello
`,49),r=[o];function l(p,c,d,y,i,D){return e(),a("div",null,r)}const C=s(n,[["render",l]]);export{F as __pageData,C as default};
+// text = HelloThis page is about the GuidOptions class available in PeyrSharp.Core. You can find here all of its properties.
The GuidOptions class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes GuidOptions with default values for its properties.
using PeyrSharp.Core;
+import{_ as s,o as e,c as a,R as n}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"GuidOptions","description":"","frontmatter":{},"headers":[],"relativePath":"core/guid-options.md","filePath":"core/guid-options.md","lastUpdated":1665313649000}'),t={name:"core/guid-options.md"},o=n(`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/Platform Windows macOS Linux + 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();
/*
@@ -16,4 +16,4 @@ import{_ as s,c as e,o as a,R as n}from"./chunks/framework.bdd825cc.js";const C=
- Hyphens = true
- 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.
`,41),l=[o];function i(p,c,r,d,h,y){return a(),e("div",null,l)}const g=s(t,[["render",i]]);export{C as __pageData,g as default};
+*/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.
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.
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.
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.
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.
The GuidGen class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
The Generate() method generates a Guid and will return it as a string.
INFO
This method has different overloads.
This method has no arguments.
using PeyrSharp.Core;
+import{_ as e,o as a,c as s,R as t}from"./chunks/framework.8e8e72cd.js";const m=JSON.parse('{"title":"GuidGen","description":"","frontmatter":{},"headers":[],"relativePath":"core/guid.md","filePath":"core/guid.md","lastUpdated":1665311928000}'),n={name:"core/guid.md"},o=t(`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/Platform Windows macOS Linux + 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:
Type Name Meaning intlengthThe length of the Guid.
WARNING
The length must be a number, otherwise, it will thrown a InvalidGuidLengthException.
Usage
c#using PeyrSharp.Core;
@@ -10,4 +10,4 @@ import{_ as e,c as a,o as s,R as t}from"./chunks/framework.bdd825cc.js";const m=
// 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:
Type Name Meaning GuidOptionsguidOptionsThe 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)
`,43),l=[o];function r(i,c,d,p,h,u){return s(),a("div",null,l)}const y=e(n,[["render",r]]);export{m as __pageData,y as default};
+// guid = {35c3ab90-7636-4d34-a439-bc65eb3c} (example)This page is about the Internet class available in PeyrSharp.Core. You can find here all of its methods.
INFO
This class is static.
The Internet class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Checks if a connection to the Internet is available. Returns a bool value.
INFO
This method is asynchronous and awaitable.
This method has no arguments
using PeyrSharp.Core;
+import{_ as s,o as a,c as n,R as e}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"Internet","description":"","frontmatter":{},"headers":[],"relativePath":"core/internet.md","filePath":"core/internet.md","lastUpdated":1683446294000}'),t={name:"core/internet.md"},o=e(`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/Platform Windows macOS Linux + 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()
{
@@ -52,4 +52,4 @@ import{_ as s,c as a,o as n,R as e}from"./chunks/framework.bdd825cc.js";const F=
// protocol = https
IsUrlValid(url)
Definition
Checks if a URL is valid or not.. Returns a bool.
Arguments
Type Name Meaning 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
`,71),l=[o];function p(r,c,i,d,y,D){return n(),a("div",null,l)}const u=s(t,[["render",p]]);export{F as __pageData,u as default};
+// valid = falseThis page is about the Maths namespace available in PeyrSharp.Core. You can find here all of its classes.
The Maths namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
This page is about the Maths namespace available in PeyrSharp.Core. You can find here all of its classes.
The Maths namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
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.
The Algebra class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Returns the sum of specified double numbers. It returns a double value.
| Type | Name | Meaning |
|---|---|---|
params double[] | numbers | The numbers to do the sum of. |
using PeyrSharp.Core.Maths;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Algebra","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/algebra.md","filePath":"core/maths/algebra.md","lastUpdated":1666370076000}'),t={name:"core/maths/algebra.md"},o=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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);
@@ -36,4 +36,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
// negative = -7
GetResultsOf(function, numbers)
Definition
Gets the results of a function applied to specific double numbers. It returns an array of double[].
Arguments
Type Name Meaning 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;
double res = Algebra.GetResultsOf(x => x * x, 1, 2, 3, 4);
-// res = double[] { 1, 4, 9, 16 }
`,63),l=[o];function r(p,c,i,d,h,u){return e(),s("div",null,l)}const C=a(t,[["render",r]]);export{D as __pageData,C as default};
+// res = double[] { 1, 4, 9, 16 }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.
The namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
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.
The namespace is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
This page is about the Circle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Circle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Circle class from a specific radius.
| Type | Name | Meaning |
|---|---|---|
double | radius | The radius of the circle. |
WARNING
If radius ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.8e8e72cd.js";const u=JSON.parse('{"title":"Circle","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/circle.md","filePath":"core/maths/geometry/circle.md","lastUpdated":1665756380000}'),o={name:"core/maths/geometry/circle.md"},n=t(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Constructors
Circle(radius)
Definition
Initializes a Circle class from a specific radius.
Arguments
Type Name Meaning 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;
@@ -10,4 +10,4 @@ import{_ as a,c as e,o as s,R as t}from"./chunks/framework.bdd825cc.js";const u=
Circle circle = new(10);
var perimeter = circle.Perimeter;
-// perimeter = 62.83185307179586
`,27),l=[n];function r(c,p,i,d,h,y){return s(),e("div",null,l)}const D=a(o,[["render",r]]);export{u as __pageData,D as default};
+// perimeter = 62.83185307179586This page is about the Cone class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Cone class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Cone class from a specific radius and height.
| Type | Name | Meaning |
|---|---|---|
double | radius | The radius of the cone. |
double | height | The height of the cone. |
WARNING
If radius or height ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Cone","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/cone.md","filePath":"core/maths/geometry/cone.md","lastUpdated":1665652653000}'),n={name:"core/maths/geometry/cone.md"},t=o(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
@@ -15,4 +15,4 @@ import{_ as a,c as s,o as e,R as o}from"./chunks/framework.bdd825cc.js";const D=
Circle cone = new(10, 40);
var height = cone.Height;
-// height = 40
`,33),l=[t];function p(r,c,i,d,h,y){return e(),s("div",null,l)}const u=a(n,[["render",p]]);export{D as __pageData,u as default};
+// height = 40This page is about the Cube class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Cube class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Cube class from the length of the side of the cube.
| Type | Name | Meaning |
|---|---|---|
double | side | The length of the side of the cube. |
WARNING
If side ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as s,o as a,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Cube","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/cube.md","filePath":"core/maths/geometry/cube.md","lastUpdated":1665652653000}'),o={name:"core/maths/geometry/cube.md"},l=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning 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;
@@ -37,4 +37,4 @@ import{_ as s,c as a,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Cube cube = new(10);
var width = cube.Width;
-// width = 10
`,66),t=[l];function p(c,r,i,d,h,y){return e(),a("div",null,t)}const u=s(o,[["render",p]]);export{D as __pageData,u as default};
+// width = 10This page is about the Cylinder class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Cylinder class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Cylinder class from a specific radius and height.
| Type | Name | Meaning |
|---|---|---|
double | radius | The radius of the cylinder. |
double | height | The height of the cylinder. |
WARNING
If radius or height ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Cylinder","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/cylinder.md","filePath":"core/maths/geometry/cylinder.md","lastUpdated":1665652653000}'),o={name:"core/maths/geometry/cylinder.md"},l=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
@@ -20,4 +20,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Cylinder cylinder = new(10, 40);
var height = cylinder.Height;
-// height = 40
`,39),t=[l];function p(r,c,i,d,h,y){return e(),s("div",null,t)}const F=a(o,[["render",p]]);export{D as __pageData,F as default};
+// height = 40This page is about the Diamond class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Diamond class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Diamond class from the length of its side.
| Type | Name | Meaning |
|---|---|---|
double | side | The length of the side. |
WARNING
If side ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Diamond","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/diamond.md","filePath":"core/maths/geometry/diamond.md","lastUpdated":1666360764000}'),o={name:"core/maths/geometry/diamond.md"},l=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning 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;
@@ -23,4 +23,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Diamond diamond = new(10, 14);
var side = diamond.Diagonals;
-// side = { 10, 14 }
`,49),t=[l];function p(i,r,c,d,h,y){return e(),s("div",null,t)}const F=a(o,[["render",p]]);export{D as __pageData,F as default};
+// side = { 10, 14 }This page is about the Hexagon class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Hexagon class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Hexagon class from the length of its side.
| Type | Name | Meaning |
|---|---|---|
double | side | The length of the side of the hexagon. |
WARNING
If side ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Hexagon","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/hexagon.md","filePath":"core/maths/geometry/hexagon.md","lastUpdated":1665753720000}'),n={name:"core/maths/geometry/hexagon.md"},t=o(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
@@ -14,4 +14,4 @@ import{_ as a,c as s,o as e,R as o}from"./chunks/framework.bdd825cc.js";const D=
Hexagon hexagon = new(10);
-var side = hexagon.Side; // side = 10
`,33),l=[t];function p(r,c,i,d,h,y){return e(),s("div",null,l)}const F=a(n,[["render",p]]);export{D as __pageData,F as default};
+var side = hexagon.Side; // side = 10This page is about the Pyramid class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors, methods and properties.
The Pyramid class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Pyramid class from a specific width, length, and height.
| Type | Name | Meaning |
|---|---|---|
double | width | The width of the pyramid. |
double | length | The length of the pyramid. |
double | height | The height of the pyramid. |
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Pyramid","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/pyramid.md","filePath":"core/maths/geometry/pyramid.md","lastUpdated":1665753720000}'),o={name:"core/maths/geometry/pyramid.md"},l=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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
Type Name Meaning doublevolumeThe volume of the pyramid. doublewidthThe width of the pyramid. doublelengthThe length of the pyramid.
Usage
c#using PeyrSharp.Core.Maths.Geometry;
@@ -41,4 +41,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Pyramid pyramid = new(10, 20, 30);
var height = pyramid.Height;
-// height = 30
`,78),t=[l];function p(r,c,i,d,h,y){return e(),s("div",null,t)}const F=a(o,[["render",p]]);export{D as __pageData,F as default};
+// height = 30This page is about the Rectangle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Rectangle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Rectangle class from a specific length and width.
| Type | Name | Meaning |
|---|---|---|
double | width | The width of the rectangle. |
double | length | The length of the rectangle. |
WARNING
If width or length ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Rectangle","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/rectangle.md","filePath":"core/maths/geometry/rectangle.md","lastUpdated":1665754402000}'),l={name:"core/maths/geometry/rectangle.md"},o=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
@@ -25,4 +25,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Rectangle rectangle = new(10, 20);
var length = rectangle.Length;
-// length = 20
`,45),t=[o];function p(r,c,i,d,h,y){return e(),s("div",null,t)}const F=a(l,[["render",p]]);export{D as __pageData,F as default};
+// length = 20This page is about the Sphere class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Sphere class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Sphere class from a specific radius.
| Type | Name | Meaning |
|---|---|---|
double | radius | The radius of the sphere. |
WARNING
If radius ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.8e8e72cd.js";const u=JSON.parse('{"title":"Sphere","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/sphere.md","filePath":"core/maths/geometry/sphere.md","lastUpdated":1665754815000}'),n={name:"core/maths/geometry/sphere.md"},t=o(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Constructors
Sphere(radius)
Definition
Initializes a Sphere class from a specific radius.
Arguments
Type Name Meaning 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;
@@ -15,4 +15,4 @@ import{_ as a,c as s,o as e,R as o}from"./chunks/framework.bdd825cc.js";const u=
Sphere sphere = new(10);
var radius = sphere.Radius;
-// radius = 10
`,33),l=[t];function p(r,c,i,d,h,y){return e(),s("div",null,l)}const D=a(n,[["render",p]]);export{u as __pageData,D as default};
+// radius = 10This page is about the Triangle class available in PeyrSharp.Core.Maths.Geometry. You can find here all of its constructors and properties.
The Triangle class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Initializes a Triangle class from the length of its sides.
| Type | Name | Meaning |
|---|---|---|
double | side1 | The length of the first side of the triangle. |
double | side2 | The length of the second side of the triangle. |
double | side3 | The length of the third side of the triangle. |
WARNING
If side1, side2, or side3 ≤ 0, a DivideByZeroException will be thrown.
using PeyrSharp.Core.Maths.Geometry;
+import{_ as s,o as a,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Triangle","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/geometry/triangle.md","filePath":"core/maths/geometry/triangle.md","lastUpdated":1665755989000}'),l={name:"core/maths/geometry/triangle.md"},o=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
Triangle triangle = new(10, 20, 10); // Creates a triangle
Triangle(width, height)
Definition
Initializes a Triangle class from a width and height.
Arguments
Type Name Meaning doublewidthThe width of the triangle. doubleheightThe height of the triangle.
Usage
c#using PeyrSharp.Core.Maths.Geometry;
@@ -53,4 +53,4 @@ import{_ as s,c as a,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
Triangle triangle = new(10, 20, 15);
var side3 = triangle.Side3;
-// side3 = 15
`,87),t=[o];function p(r,c,i,d,h,y){return e(),a("div",null,t)}const F=s(l,[["render",p]]);export{D as __pageData,F as default};
+// side3 = 15This page is about the Percentages class available in PeyrSharp.Core.Maths. You can find here all of its methods.
INFO
This class is static.
The Percentages class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Returns the value after an increase of x% as a double.
| Type | Name | Meaning |
|---|---|---|
double | value | The original value. |
double | increaseRate | The increase percentage (as x/100d). |
using PeyrSharp.Core.Maths;
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const g=JSON.parse('{"title":"Percentages","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/percentages.md","filePath":"core/maths/percentages.md","lastUpdated":1666371130000}'),o={name:"core/maths/percentages.md"},n=s(`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/Platform Windows macOS Linux + 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
Type Name Meaning doublevalueThe original value. doubleincreaseRateThe 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
Type Name Meaning doublevalueThe original value. doubledecreaseRateThe decrease percentage (as x/100d).
Usage
c#using PeyrSharp.Core.Maths;
@@ -10,4 +10,4 @@ import{_ as e,c as a,o as t,R as s}from"./chunks/framework.bdd825cc.js";const g=
// ev = -0.09090909090909094
ProportionToPercentageString(proportion)
Definition
Formats a proportion to a string.
Arguments
Type Name Meaning doubleproportionThe proportion to get the percentage of.
Usage
c#using PeyrSharp.Core.Maths;
double proportion = Percentages.ProportionToPercentageString(0.5);
-// proportion = 50%
`,35),r=[n];function l(c,p,i,d,h,u){return t(),a("div",null,r)}const b=e(o,[["render",l]]);export{g as __pageData,b as default};
+// proportion = 50%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.
The Proba class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Gets a random value based on the specified probabilities. Returns a randomly selected value.
| Type | Name | Meaning |
|---|---|---|
T | - | The type of the values to select from. |
| Type | Name | Meaning |
|---|---|---|
Dictionary<T, double> | probabilities | A dictionary containing the probability of getting each value. |
ArgumentException: Thrown if the sum of probabilities is not equal to 1.Exception: Thrown if an unexpected error occurs while selecting a random value.using PeyrSharp.Core.Maths;
+import{_ as a,o as t,c as s,R as e}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Proba","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/proba.md","filePath":"core/maths/proba.md","lastUpdated":1675590267000}'),o={name:"core/maths/proba.md"},n=e(`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/Platform Windows macOS Linux + 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
Type Name Meaning T- The type of the values to select from.
Parameters
Type Name Meaning 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;
Dictionary<string, double> probabilities = new Dictionary<string, double>
{
@@ -6,4 +6,4 @@ import{_ as a,c as t,o as s,R as e}from"./chunks/framework.bdd825cc.js";const D=
{ "Tails", 0.5 }
};
-string result = Proba.GetRandomValue(probabilities);
`,18),l=[n];function r(p,i,c,d,h,y){return s(),t("div",null,l)}const C=a(o,[["render",r]]);export{D as __pageData,C as default};
+string result = Proba.GetRandomValue(probabilities);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.
The Stats class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
Returns the mean of a dataset as a double.
| Type | Name | Meaning |
|---|---|---|
List<double> | values | The dataset to calculate. |
| Type | Meaning |
|---|---|
ArgumentException | Thrown if the dataset is empty. |
using PeyrSharp.Core.Maths;
+import{_ as a,o as s,c as t,R as e}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Stats","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/stats.md","filePath":"core/maths/stats.md","lastUpdated":1673177412000}'),o={name:"core/maths/stats.md"},n=e(`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/Platform Windows macOS Linux + others Core ✅ ✅ ✅ Framework .NET 5 .NET 6 .NET 7 Core ✅ ✅ ✅
Methods
Mean(values)
Definition
Returns the mean of a dataset as a double.
Arguments
Type Name Meaning List<double>valuesThe dataset to calculate.
Exceptions
Type Meaning 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
@@ -10,4 +10,4 @@ import{_ as a,c as s,o as t,R as e}from"./chunks/framework.bdd825cc.js";const D=
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
`,34),l=[n];function p(r,c,d,i,h,y){return t(),s("div",null,l)}const F=a(o,[["render",p]]);export{D as __pageData,F as default};
+// mode = 3This page is about the Trigonometry class available in PeyrSharp.Core.Maths. You can find here all of its methods.
INFO
This class is static.
The Trigonometry class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
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.
| Type | Name | Meaning |
|---|---|---|
TriangleSides | triangleSide | The side of the triangle. |
double | angle | The value of the angle. |
double | value | The length of the chosen side. |
WARNING
If triangleSide is equal to TriangleSides.Opposed, an Exception will be thrown.
using PeyrSharp.Core.Maths;
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.8e8e72cd.js";const u=JSON.parse('{"title":"Trigonometry","description":"","frontmatter":{},"headers":[],"relativePath":"core/maths/trigonometry.md","filePath":"core/maths/trigonometry.md","lastUpdated":1666370076000}'),o={name:"core/maths/trigonometry.md"},n=s(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
using PeyrSharp.Enums;
double opposed = Trigonometry.GetOpposedSideFrom(TriangleSides.Adjacent, 1.05, 5);
@@ -10,4 +10,4 @@ import{_ as e,c as a,o as t,R as s}from"./chunks/framework.bdd825cc.js";const u=
using PeyrSharp.Enums;
double hypotenuse = Trigonometry.GetHypotenuseFrom(TriangleSides.Opposed, 1.05, 8.71);
-// hypotenuse = 10.041234478169912
`,31),l=[n];function r(d,i,p,c,h,g){return t(),a("div",null,l)}const m=e(o,[["render",r]]);export{u as __pageData,m as default};
+// hypotenuse = 10.041234478169912This page is about the Password class available in PeyrSharp.Core. You can find here all of its methods.
INFO
This class is static.
The Password class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
The GenerateAsync() method generates a password of a specific length, with specific characters asynchronously.
| Type | Name | Meaning |
|---|---|---|
int | length | The length of the password. |
string | characters | The characters that can be included in the password. Separated with a unique separator. |
string | separator | The separator used to separate the specified characters. |
using PeyrSharp.Core;
+import{_ as s,o as a,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"Password","description":"","frontmatter":{},"headers":[],"relativePath":"core/password.md","filePath":"core/password.md","lastUpdated":1665311928000}'),n={name:"core/password.md"},o=t(`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/Platform Windows macOS Linux + 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
Type Name Meaning 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;
private async void Main()
{
@@ -26,4 +26,4 @@ import{_ as s,c as a,o as e,R as t}from"./chunks/framework.bdd825cc.js";const F=
{
// Generate 10 passwords with 10 characters with the simple preset
List<string> passwords = await Password.GenerateAsync(10, 10, PasswordPresets.Simple);
-}
`,35),l=[o];function r(p,c,d,i,h,y){return e(),a("div",null,l)}const C=s(n,[["render",r]]);export{F as __pageData,C as default};
+}This page is about the StatusInfo class available in PeyrSharp.Core. You can find here all of its methods.
The StatusInfo class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
public int StatusCode { get; set; }Gets or sets the status code that indicates the outcome of the request.
public string StatusDescription { get; set; }Gets or sets the status description that provides a human-readable message of the status code.
public StatusCodes StatusType { get; set; }Gets or sets the status type that categorizes the status code into informational, success, redirection, client error, or server error. The StatusCodes is an enumeration representing the type of HTTP status codes that can be returned.
This page is about the StatusInfo class available in PeyrSharp.Core. You can find here all of its methods.
The StatusInfo class is part of the PeyrSharp.Core module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Core | ✅ | ✅ | ✅ |
public int StatusCode { get; set; }Gets or sets the status code that indicates the outcome of the request.
public string StatusDescription { get; set; }Gets or sets the status description that provides a human-readable message of the status code.
public StatusCodes StatusType { get; set; }Gets or sets the status type that categorizes the status code into informational, success, redirection, client error, or server error. The StatusCodes is an enumeration representing the type of HTTP status codes that can be returned.
This page is about the enumerations available in PeyrSharp.Enums. They are grouped by category.
Enumerations are part of the PeyrSharp.Enums module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Enums | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Enums | ✅ | ✅ | ✅ |
The StorageUnits enumeration represents all possible numeric storage units. It contains the following values:
| Value | Name | Meaning |
|---|---|---|
| 0 | Byte | The byte unit. (b) |
| 1 | Kilobyte | The kilobyte unit. (kb) |
| 2 | Megabyte | The megabyte unit. (mb) |
| 3 | Gigabyte | The gigabyte unit. (gb) |
| 4 | Terabyte | The terabyte unit. (tb) |
| 5 | Petabyte | The petabyte unit. (pb) |
public static double ToPetabyte(double value, StorageUnits unit)
+import{_ as s,o as a,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const h=JSON.parse('{"title":"Enumerations","description":"","frontmatter":{},"headers":[],"relativePath":"enumerations.md","filePath":"enumerations.md","lastUpdated":1680429306000}'),t={name:"enumerations.md"},o=n(`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/Platform Windows macOS Linux + 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:
Value Name Meaning 0 ByteThe byte unit. (b) 1 KilobyteThe kilobyte unit. (kb) 2 MegabyteThe megabyte unit. (mb) 3 GigabyteThe gigabyte unit. (gb) 4 TerabyteThe terabyte unit. (tb) 5 PetabyteThe petabyte unit. (pb)
Example
c#public static double ToPetabyte(double value, StorageUnits unit)
{
if (unit == StorageUnits.Terabyte)
{
@@ -65,4 +65,4 @@ import{_ as s,c as a,o as e,R as n}from"./chunks/framework.bdd825cc.js";const h=
WinFormsHelpers.CenterControl(button1, this, ControlAlignment.Horizontal);
}
}
-}
`,78),l=[o];function p(r,c,i,d,D,y){return e(),a("div",null,l)}const C=s(t,[["render",p]]);export{h as __pageData,C as default};
+}This page is about the PeyrSharp.Env module.
The PeyrSharp.Env module is compatible with all of these frameworks and platforms:
| 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.
This page is about the PeyrSharp.Env module.
The PeyrSharp.Env module is compatible with all of these frameworks and platforms:
| 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.
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.
The FileSys 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 | ✅ | ✅ | ✅ |
WARNING
Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.
Gets the amount of available storage on a specified drive. It returns double.
| Type | Name | Meaning |
|---|---|---|
string | drive | The drive letter or name to get the amount of available space. |
StorageUnits | unit | The unit of the returned result. |
using PeyrSharp.Enums;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"FileSys","description":"","frontmatter":{},"headers":[],"relativePath":"env/filesys.md","filePath":"env/filesys.md","lastUpdated":1675590267000}'),t={name:"env/filesys.md"},o=n(`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/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
GetAvailableSpace(drive, unit)
Definition
Gets the amount of available storage on a specified drive. It returns double.
Arguments
Type Name Meaning stringdriveThe 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
Type Name Meaning DriveInfodriveInfoThe DriveInfo object to get the amount of available space. StorageUnitsunitThe unit of the returned result.
Usage
c#using PeyrSharp.Enums;
@@ -71,4 +71,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const F=
string currentDirectory = FileSys.CurrentDirectory;
ComputerName
Definition
Returns the name of the current computer as a string.
Usage
c#using PeyrSharp.Env;
-string computerName = FileSys.ComputerName;
`,126),l=[o];function p(r,i,c,d,D,y){return e(),s("div",null,l)}const u=a(t,[["render",p]]);export{F as __pageData,u as default};
+string computerName = FileSys.ComputerName;This page is about the Logger class available in PeyrSharp.Env. You can find here all of its methods.
INFO
This class is static.
The Logger 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 | ✅ | ✅ | ✅ |
WARNING
Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.
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.
| Type | Name | Meaning |
|---|---|---|
string | message | The message or text that needs to be logged. |
string | filePath | The path where the file should be written. |
DateTime | dateTime | The timestamp of the log, the time when the log was made. |
using PeyrSharp.Env;
+import{_ as a,o as s,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const y=JSON.parse('{"title":"Logger","description":"","frontmatter":{},"headers":[],"relativePath":"env/logger.md","filePath":"env/logger.md","lastUpdated":1680429326000}'),o={name:"env/logger.md"},n=t(`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/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
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
Type Name Meaning 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;
Logger.Log("Hello", @"C:\\Logs\\log1.txt", DateTime.Now)
// The line above will generate a file with the following content:
@@ -16,4 +16,4 @@ import{_ as a,c as s,o as e,R as t}from"./chunks/framework.bdd825cc.js";const y=
DateTime date = DateTime.Now;
LogLevel logLevel = LogLevel.Warning;
-Logger.Log(message, filePath, date, logLevel);
`,30),l=[n];function p(r,c,i,d,h,g){return e(),s("div",null,l)}const m=a(o,[["render",p]]);export{y as __pageData,m as default};
+Logger.Log(message, filePath, date, logLevel);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.
The Sys 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 | ✅ | ✅ | ✅ |
WARNING
Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.
Executes a program in administrator mode.
WARNING
This method only works on Windows.
| Type | Name | Meaning |
|---|---|---|
Process | process | The process to launch as admin. |
using PeyrSharp.Env;
+import{_ as s,o as a,c as n,R as e}from"./chunks/framework.8e8e72cd.js";const h=JSON.parse('{"title":"Sys","description":"","frontmatter":{},"headers":[],"relativePath":"env/system.md","filePath":"env/system.md","lastUpdated":1675590267000}'),o={name:"env/system.md"},l=e(`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/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
ExecuteAsAdmin(process)
Definition
Executes a program in administrator mode.
WARNING
This method only works on Windows.
Arguments
Type Name Meaning ProcessprocessThe process to launch as admin.
Usage
c#using PeyrSharp.Env;
// Define a process
Process p = new();
@@ -62,4 +62,4 @@ import{_ as s,c as a,o as n,R as e}from"./chunks/framework.bdd825cc.js";const h=
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;
-int unixTime = Sys.UnixTime;
`,90),t=[l];function p(c,r,i,y,d,D){return n(),a("div",null,t)}const C=s(o,[["render",p]]);export{h as __pageData,C as default};
+int unixTime = Sys.UnixTime;This page is about the Update class available in PeyrSharp.Env. You can find here all of its methods.
INFO
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 | ✅ | ✅ | ✅ |
WARNING
Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.
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.
| Type | Name | Meaning |
|---|---|---|
string | url | Link of the file where the latest version is stored. |
using PeyrSharp.Env;
+import{_ as s,o as a,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"Update","description":"","frontmatter":{},"headers":[],"relativePath":"env/update.md","filePath":"env/update.md","lastUpdated":1683354316000}'),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/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
This method is asynchronous and awaitable.
Arguments
Type Name Meaning stringurlLink of the file where the latest version is stored.
Usage
c#using PeyrSharp.Env;
private async void Main()
{
@@ -14,4 +14,4 @@ import{_ as s,c as a,o as e,R as t}from"./chunks/framework.bdd825cc.js";const F=
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};
+}This page is about the exceptions available in PeyrSharp.Exceptions. They are grouped by category.
Exceptions are part of the PeyrSharp.Exceptions module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Exceptions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Exceptions | ✅ | ✅ | ✅ |
The RGBInvalidValueException is an exception used in the Converters class when you provide an invalid value for a RGB color.
using PeyrSharp.Exceptions;
+import{_ as a,o as e,c as s,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Exceptions","description":"","frontmatter":{},"headers":[],"relativePath":"exceptions.md","filePath":"exceptions.md","lastUpdated":1665311928000}'),o={name:"exceptions.md"},t=n(`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/Platform Windows macOS Linux + 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;
@@ -10,4 +10,4 @@ import{_ as a,c as e,o as s,R as n}from"./chunks/framework.bdd825cc.js";const D=
if (length <= 0 || length > 32)
{
throw new InvalidGuidLengthException("The length of a Guid must be between 1 and 32.");
-}
`,22),l=[t];function i(p,r,c,d,h,u){return s(),e("div",null,l)}const C=a(o,[["render",i]]);export{D as __pageData,C as default};
+}This page is about the PeyrSharp.Extensions module.
The PeyrSharp.Extensions module is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
This page is about the PeyrSharp.Extensions module.
The PeyrSharp.Extensions module is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
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.
The ArrayExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
The Append<T>() method adds an item to an existing array of any type. It returns an array of the chosen type (T[]).
| Type | Name | Meaning |
|---|---|---|
T | item | The item to append in the array. |
using PeyrSharp.Extensions;
+import{_ as a,o as s,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const F=JSON.parse('{"title":"ArrayExtensions","description":"","frontmatter":{},"headers":[],"relativePath":"extensions/array.md","filePath":"extensions/array.md","lastUpdated":1673177468000}'),t={name:"extensions/array.md"},o=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning TitemThe item to append in the array.
Usage
c#using PeyrSharp.Extensions;
int[] numbers = { 1, 2, 3, 4 };
int[] appendNumbers = numbers.Append(5);
@@ -18,4 +18,4 @@ import{_ as a,c as s,o as e,R as n}from"./chunks/framework.bdd825cc.js";const F=
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"
`,42),l=[o];function p(r,c,i,d,y,h){return e(),s("div",null,l)}const C=a(t,[["render",p]]);export{F as __pageData,C as default};
+// final = "a, b, c, d"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.
The DoubleExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
Calculates the mean (average) of a dataset. Returns the mean of the dataset as double.
| Type | Condition |
|---|---|
System.ArgumentException | Thrown if the dataset is empty. |
using PeyrSharp.Extensions;
+import{_ as a,o as s,c as e,R as t}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"DoubleExtensions","description":"","frontmatter":{},"headers":[],"relativePath":"extensions/double.md","filePath":"extensions/double.md","lastUpdated":1680429319000}'),n={name:"extensions/double.md"},o=t(`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/Platform Windows macOS Linux + 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
Type Condition 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
Type Condition ArgumentExceptionThrown if the dataset is empty.
Usage
c#using PeyrSharp.Extensions;
@@ -48,4 +48,4 @@ import{_ as a,c as s,o as e,R as t}from"./chunks/framework.bdd825cc.js";const C=
// 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
Type Name Meaning StorageUnitsstorageUnitThe unit of the value. (ex: kilobyte, gigabyte...)
Usage
c#using PeyrSharp.Core.Converters;
double petabyte = 1000.ToPetabyte(StorageUnits.Terabyte);
-// petabyte = 1
`,115),l=[o];function r(p,i,c,d,h,y){return e(),s("div",null,l)}const D=a(n,[["render",r]]);export{C as __pageData,D as default};
+// petabyte = 1This page is about the IntExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.
INFO
This class is static.
The IntExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
Gets all divisors of a specific number. Returns an array of int[].
This method does not have any arguments.
using PeyrSharp.Extensions;
+import{_ as s,o as a,c as n,R as e}from"./chunks/framework.8e8e72cd.js";const C=JSON.parse('{"title":"IntExtensions","description":"","frontmatter":{},"headers":[],"relativePath":"extensions/int.md","filePath":"extensions/int.md","lastUpdated":1680429319000}'),o={name:"extensions/int.md"},t=e(`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/Platform Windows macOS Linux + 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;
@@ -17,4 +17,4 @@ import{_ as s,c as a,o as n,R as e}from"./chunks/framework.bdd825cc.js";const C=
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;
-double d = 16.ToDouble(); // 16.0d
`,49),l=[t];function p(r,i,c,d,h,y){return n(),a("div",null,l)}const F=s(o,[["render",p]]);export{C as __pageData,F as default};
+double d = 16.ToDouble(); // 16.0dThis page is about the StringExtensions class available in PeyrSharp.Extensions. You can find here all of its extension methods.
INFO
This class is static.
The StringExtensions class is part of the PeyrSharp.Extensions module, and is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Extensions | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Extensions | ✅ | ✅ | ✅ |
Counts the number of words in a string. Returns int.
This method has no arguments.
using PeyrSharp.Extensions;
+import{_ as s,o as a,c as e,R as n}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"StringExtensions","description":"","frontmatter":{},"headers":[],"relativePath":"extensions/string.md","filePath":"extensions/string.md","lastUpdated":1678016378000}'),t={name:"extensions/string.md"},o=n(`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/Platform Windows macOS Linux + 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
Type Name Meaning string[]wordSeparatorThe separator of the words.
Usage
c#using PeyrSharp.Extensions;
@@ -37,4 +37,4 @@ import{_ as s,c as a,o as e,R as n}from"./chunks/framework.bdd825cc.js";const D=
// upper = "Test"
Reverse(input)
Definition
Reverses a string.
Arguments
Type Name Description stringinputThe string to reverse.
Returns
A string representing the reversed input.
Usage
c#using PeyrSharp.Extensions;
string reversed = "Hello, world!".Reverse();
-// Output: "!dlrow ,olleH"
`,88),l=[o];function r(p,c,i,d,h,u){return e(),a("div",null,l)}const F=s(t,[["render",r]]);export{D as __pageData,F as default};
+// Output: "!dlrow ,olleH"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:
string, int, double or arrays (T[]).T[])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 | ✅ | ❌ | ❌ |
Caption:
PeyrSharp is available in the following frameworks
INFO
.NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported.
PeyrShall is available on NuGet, you can install it by running the following command:
You can add PeyrSharp to your project the .NET CLI.
dotnet add package PeyrSharp --version 1.0.0.2211NuGet\\Install-Package PeyrSharp -Version 1.0.0.2211You can specify in your project file that it is dependent on PeyrSharp.
<PackageReference Include="PeyrSharp" Version="1.0.0.2211" />To call methods and classes included in PeyrSharp, you will need to add the corresponding using directives in your code file.
using PeyrSharp.Core;
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.8e8e72cd.js";const m=JSON.parse('{"title":"Get Started","description":"","frontmatter":{},"headers":[],"relativePath":"get-started.md","filePath":"get-started.md","lastUpdated":1683355029000}'),l={name:"get-started.md"},o=t(`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/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
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.
powershelldotnet add package PeyrSharp --version 1.0.0.2211
Package Manager
shNuGet\\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
`,35),n=[o];function r(i,p,c,d,h,u){return s(),e("div",null,n)}const g=a(l,[["render",r]]);export{m as __pageData,g as default};
+using PeyrSharp.UiHelpers; // Windows onlyFor more information, you can check the reference
`,35),n=[o];function r(i,p,c,d,h,u){return e(),s("div",null,n)}const g=a(l,[["render",r]]);export{m as __pageData,g as default}; diff --git a/docs/assets/get-started.md.ac86dbb2.lean.js b/docs/assets/get-started.md.7ba0cc88.lean.js similarity index 53% rename from docs/assets/get-started.md.ac86dbb2.lean.js rename to docs/assets/get-started.md.7ba0cc88.lean.js index 41b6f2d..715659d 100644 --- a/docs/assets/get-started.md.ac86dbb2.lean.js +++ b/docs/assets/get-started.md.7ba0cc88.lean.js @@ -1 +1 @@ -import{_ as a,c as e,o as s,R as t}from"./chunks/framework.bdd825cc.js";const m=JSON.parse('{"title":"Get Started","description":"","frontmatter":{},"headers":[],"relativePath":"get-started.md","filePath":"get-started.md","lastUpdated":1683355029000}'),l={name:"get-started.md"},o=t("",35),n=[o];function r(i,p,c,d,h,u){return s(),e("div",null,n)}const g=a(l,[["render",r]]);export{m as __pageData,g as default}; +import{_ as a,o as e,c as s,R as t}from"./chunks/framework.8e8e72cd.js";const m=JSON.parse('{"title":"Get Started","description":"","frontmatter":{},"headers":[],"relativePath":"get-started.md","filePath":"get-started.md","lastUpdated":1683355029000}'),l={name:"get-started.md"},o=t("",35),n=[o];function r(i,p,c,d,h,u){return e(),s("div",null,n)}const g=a(l,[["render",r]]);export{m as __pageData,g as default}; diff --git a/docs/assets/index.md.3e538f10.js b/docs/assets/index.md.76d2aa15.js similarity index 89% rename from docs/assets/index.md.3e538f10.js rename to docs/assets/index.md.76d2aa15.js index f80c4fe..180eaea 100644 --- a/docs/assets/index.md.3e538f10.js +++ b/docs/assets/index.md.76d2aa15.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.bdd825cc.js";const m=JSON.parse(`{"title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","description":"","frontmatter":{"layout":"home","title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","hero":{"name":"PeyrSharp","text":"Made for you.","tagline":"A C# library designed to make developers' job easier.","image":{"src":"/logo.png","alt":"PeyrSharp"},"actions":[{"theme":"brand","text":"Get Started","link":"/get-started"},{"theme":"alt","text":"Reference","link":"/reference"}]},"features":[{"title":"Easy-to-use","details":"Using PeyrSharp in a project is very easy and intuitive.","icon":"✅"},{"title":".NET Powered","details":"PeyrSharp is built using C# and .NET. It's available for projects targeting .NET 5 and higher.","icon":"🚀"},{"title":"Cross-Platform","details":"PeyrSharp is compatible with every operating systems that .NET supports.","icon":"🖥️"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1665305917000}`),r={name:"index.md"};function i(s,o,n,l,d,p){return a(),t("div")}const h=e(r,[["render",i]]);export{m as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.8e8e72cd.js";const m=JSON.parse(`{"title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","description":"","frontmatter":{"layout":"home","title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","hero":{"name":"PeyrSharp","text":"Made for you.","tagline":"A C# library designed to make developers' job easier.","image":{"src":"/logo.png","alt":"PeyrSharp"},"actions":[{"theme":"brand","text":"Get Started","link":"/get-started"},{"theme":"alt","text":"Reference","link":"/reference"}]},"features":[{"title":"Easy-to-use","details":"Using PeyrSharp in a project is very easy and intuitive.","icon":"✅"},{"title":".NET Powered","details":"PeyrSharp is built using C# and .NET. It's available for projects targeting .NET 5 and higher.","icon":"🚀"},{"title":"Cross-Platform","details":"PeyrSharp is compatible with every operating systems that .NET supports.","icon":"🖥️"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1665305917000}`),r={name:"index.md"};function i(s,o,n,l,d,p){return t(),a("div")}const h=e(r,[["render",i]]);export{m as __pageData,h as default}; diff --git a/docs/assets/index.md.3e538f10.lean.js b/docs/assets/index.md.76d2aa15.lean.js similarity index 89% rename from docs/assets/index.md.3e538f10.lean.js rename to docs/assets/index.md.76d2aa15.lean.js index f80c4fe..180eaea 100644 --- a/docs/assets/index.md.3e538f10.lean.js +++ b/docs/assets/index.md.76d2aa15.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.bdd825cc.js";const m=JSON.parse(`{"title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","description":"","frontmatter":{"layout":"home","title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","hero":{"name":"PeyrSharp","text":"Made for you.","tagline":"A C# library designed to make developers' job easier.","image":{"src":"/logo.png","alt":"PeyrSharp"},"actions":[{"theme":"brand","text":"Get Started","link":"/get-started"},{"theme":"alt","text":"Reference","link":"/reference"}]},"features":[{"title":"Easy-to-use","details":"Using PeyrSharp in a project is very easy and intuitive.","icon":"✅"},{"title":".NET Powered","details":"PeyrSharp is built using C# and .NET. It's available for projects targeting .NET 5 and higher.","icon":"🚀"},{"title":"Cross-Platform","details":"PeyrSharp is compatible with every operating systems that .NET supports.","icon":"🖥️"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1665305917000}`),r={name:"index.md"};function i(s,o,n,l,d,p){return a(),t("div")}const h=e(r,[["render",i]]);export{m as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.8e8e72cd.js";const m=JSON.parse(`{"title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","description":"","frontmatter":{"layout":"home","title":"PeyrSharp","titleTemplate":"A C# library designed to make developers' job easier.","hero":{"name":"PeyrSharp","text":"Made for you.","tagline":"A C# library designed to make developers' job easier.","image":{"src":"/logo.png","alt":"PeyrSharp"},"actions":[{"theme":"brand","text":"Get Started","link":"/get-started"},{"theme":"alt","text":"Reference","link":"/reference"}]},"features":[{"title":"Easy-to-use","details":"Using PeyrSharp in a project is very easy and intuitive.","icon":"✅"},{"title":".NET Powered","details":"PeyrSharp is built using C# and .NET. It's available for projects targeting .NET 5 and higher.","icon":"🚀"},{"title":"Cross-Platform","details":"PeyrSharp is compatible with every operating systems that .NET supports.","icon":"🖥️"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1665305917000}`),r={name:"index.md"};function i(s,o,n,l,d,p){return t(),a("div")}const h=e(r,[["render",i]]);export{m as __pageData,h as default}; diff --git a/docs/assets/intro.md.ea6d8c4a.js b/docs/assets/intro.md.851d17d7.js similarity index 96% rename from docs/assets/intro.md.ea6d8c4a.js rename to docs/assets/intro.md.851d17d7.js index 8065285..5101736 100644 --- a/docs/assets/intro.md.ea6d8c4a.js +++ b/docs/assets/intro.md.851d17d7.js @@ -1 +1 @@ -import{_ as t,c as e,o as a,R as r}from"./chunks/framework.bdd825cc.js";const y=JSON.parse('{"title":"Introduction","description":"","frontmatter":{},"headers":[],"relativePath":"intro.md","filePath":"intro.md","lastUpdated":1683355029000}'),i={name:"intro.md"},o=r('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.
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!
PeyrSharp is divided in multiple packages:
PeyrSharp, the main package, that contains all of the followings:
string, int, double or arrays (T[]).T[])Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platform.
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Env | ✅ | ⚠️ | ⚠️ |
| Enums | ✅ | ✅ | ✅ |
| Exceptions | ✅ | ✅ | ✅ |
| Extensions | ✅ | ✅ | ✅ |
| UiHelpers | ✅ | ❌ | ❌ |
Caption:
PeyrSharp is available in the following frameworks
NOTE
.NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported.
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.
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!
PeyrSharp is divided in multiple packages:
PeyrSharp, the main package, that contains all of the followings:
string, int, double or arrays (T[]).T[])Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platform.
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Core | ✅ | ✅ | ✅ |
| Env | ✅ | ⚠️ | ⚠️ |
| Enums | ✅ | ✅ | ✅ |
| Exceptions | ✅ | ✅ | ✅ |
| Extensions | ✅ | ✅ | ✅ |
| UiHelpers | ✅ | ❌ | ❌ |
Caption:
PeyrSharp is available in the following frameworks
NOTE
.NET Framework and .NET Core are not targeted by PeyrSharp, since they are no longer supported.
The reference of PeyrSharp.
The reference of PeyrSharp.
This page is about the exceptions available in PeyrSharp.UiHelpers. They are grouped by category.
UiHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| UiHelpers | ✅ | ❌ | ❌ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| UiHelpers | ✅ | ✅ | ✅ |
This page is about the exceptions available in PeyrSharp.UiHelpers. They are grouped by category.
UiHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| UiHelpers | ✅ | ❌ | ❌ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| UiHelpers | ✅ | ✅ | ✅ |
This page is about the ScreenHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.
ScreenHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| UiHelpers | ✅ | ❌ | ❌ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| UiHelpers | ✅ | ✅ | ✅ |
Gets the DPI of the screen where the Windows Form is located. It returns a double value.
| Type | Name | Meaning |
|---|---|---|
Form | form | The form to get the DPI of. |
using PeyrSharp.UiHelpers;
+import{_ as s,o as a,c as n,R as e}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"Screen","description":"","frontmatter":{},"headers":[],"relativePath":"ui-helpers/screen.md","filePath":"ui-helpers/screen.md","lastUpdated":1673177478000}'),l={name:"ui-helpers/screen.md"},o=e(`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/Platform Windows macOS Linux + 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
Type Name Meaning FormformThe form to get the DPI of.
Usage
c#using PeyrSharp.UiHelpers;
using System;
using System.Windows.Forms;
@@ -38,4 +38,4 @@ import{_ as s,c as a,o as n,R as e}from"./chunks/framework.bdd825cc.js";const D=
{
MessageBox.Show(ScreenHelpers.GetScreenScaling(this));
}
-}
`,38),t=[o];function p(r,c,i,d,y,F){return n(),a("div",null,t)}const h=s(l,[["render",p]]);export{D as __pageData,h as default};
+}This page is about the WinFormsHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.
WinFormsHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| UiHelpers | ✅ | ❌ | ❌ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| UiHelpers | ✅ | ✅ | ✅ |
Centers horizontally and vertically a Control on a Form.
| Type | Name | Meaning |
|---|---|---|
Control | control | The control to center. |
Form | form | The form where the control needs to be centered. |
using PeyrSharp.UiHelpers;
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.8e8e72cd.js";const D=JSON.parse('{"title":"WinForms","description":"","frontmatter":{},"headers":[],"relativePath":"ui-helpers/winforms.md","filePath":"ui-helpers/winforms.md","lastUpdated":1673177478000}'),e={name:"ui-helpers/winforms.md"},l=o(`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/Platform Windows macOS Linux + 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
Type Name Meaning ControlcontrolThe control to center. FormformThe form where the control needs to be centered.
Usage
c#using PeyrSharp.UiHelpers;
using System;
using System.Windows.Forms;
@@ -34,4 +34,4 @@ import{_ as s,c as n,o as a,R as o}from"./chunks/framework.bdd825cc.js";const D=
// Put the current form in the middle of the screen
WinFormsHelpers.CenterForm(this);
}
-}
`,27),t=[l];function p(r,c,i,C,d,y){return a(),n("div",null,t)}const A=s(e,[["render",p]]);export{D as __pageData,A as default};
+}This page is about the WpfHelpers class available in PeyrSharp.UiHelpers. This page is about all of its methods.
WinFormsHelpers are part of the PeyrSharp.UiHelpers module, which is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| UiHelpers | ✅ | ❌ | ❌ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| UiHelpers | ✅ | ✅ | ✅ |
Centers a Window on the primary screen.
| Type | Name | Meaning |
|---|---|---|
Window | window | The Window to center. |
using PeyrSharp.UiHelpers;
+import{_ as e,o as t,c as a,R as s}from"./chunks/framework.8e8e72cd.js";const y=JSON.parse('{"title":"WPF","description":"","frontmatter":{},"headers":[],"relativePath":"ui-helpers/wpf.md","filePath":"ui-helpers/wpf.md","lastUpdated":1673177430000}'),o={name:"ui-helpers/wpf.md"},n=s(`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/Platform Windows macOS Linux + others UiHelpers ✅ ❌ ❌ Framework .NET 5 .NET 6 .NET 7 UiHelpers ✅ ✅ ✅
Methods
CenterWindow(window)
Definition
Centers a Window on the primary screen.
Arguments
Type Name Meaning WindowwindowThe Window to center.
Usage
c#using PeyrSharp.UiHelpers;
Window window = new Window();
-WpfHelpers.CenterWindow(window); // Center the window on the primary screen
`,13),r=[n];function l(i,d,p,c,h,m){return a(),t("div",null,r)}const u=e(o,[["render",l]]);export{y as __pageData,u as default};
+WpfHelpers.CenterWindow(window); // Center the window on the primary screen