Skip to content

Commit

Permalink
added Bcl.Numerics
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelgsharp committed Sep 13, 2023
1 parent 228cba0 commit b5db5b6
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions src/libraries/Microsoft.Bcl.Numerics/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,46 @@
## About

<!-- A description of the package and where one can find more documentation -->


As of .NET Core 2.0 and .NET Standard 2.1, the C# language has support for math (System.MathF) functions with floats. This library provides the necessary definitions of those types to support these language features on .NET Framework and on .NET Standard 2.0. This library is not necessary nor recommended when targeting versions of .NET that include the relevant support.

This comment has been minimized.

Copy link
@tannergooding

tannergooding Sep 20, 2023

Member

This should probably be .NET has support rather than the C# language has support


## Key Features

<!-- The key features of this package -->

*
*
*
* Enables the use of MathF on older .NET platforms


## How to Use

<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
```C#
using System;
using System.MathF.

This comment has been minimized.

Copy link
@danmoseley

danmoseley Sep 16, 2023

Member

using System.MathF. this will not compile -- also not necessary?

btw you could also remove starting and finished below..

This comment has been minimized.

Copy link
@ViktorHofer

ViktorHofer Sep 18, 2023

Member

fixed


internal static class Program
{
private static async Task Main()
{
Console.WriteLine("Starting...");

Console.WriteLine(MathF.Max(1f, 5f)); // returns 5f
Console.WriteLine("Finished!");
}
}
```

## Main Types

<!-- The main types provided in this library -->

The main types provided by this library are:

* ``
* ``
* ``
* `System.MathF`

## Additional Documentation

<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->

* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview)
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**)

## Related Packages

<!-- The related packages associated with this package -->
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/system.mathf)

## Feedback & Contributing

Expand Down

0 comments on commit b5db5b6

Please sign in to comment.