Dotnet/ExaArray
Dotnet/ExaArray
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation

Browse Source
This commit is contained in:
Thorsten Sommer 2020-08-22 20:20:07 +02:00
parent b72059dfa1
commit c4abad94cc
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ExaArray/ExaArray1D.cs
View File

@ -226,9 +226,13 @@ namespace Exa
#region Store and load #region Store and load
/// <summary> /// <summary>
/// Stores the exa array into a stream. /// Stores the exa array into a stream. <b>Please read the remarks regarding security issues.</b>
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// The data stored in this way should never be part of a public API. Serializing and
/// deserializing is not secure: an attacker can manipulate the data in a targeted
/// manner to compromise the API server, etc.
///
/// This method does not dispose the stream. /// This method does not dispose the stream.
/// </remarks> /// </remarks>
public void Store(Stream outputStream) public void Store(Stream outputStream)
@ -238,9 +242,13 @@ namespace Exa
} }
/// <summary> /// <summary>
/// Restores an exa array from the given stream. /// Restores an exa array from the given stream. <b>Please read the remarks regarding security issues.</b>
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// The data loaded in this way should never be part of a public API. Serializing and
/// deserializing is not secure: an attacker can manipulate the data in a targeted
/// manner to compromise the API server, etc.
///
/// This method does not dispose the stream. /// This method does not dispose the stream.
/// </remarks> /// </remarks>
public static ExaArray1D<T> Restore(Stream inputStream) public static ExaArray1D<T> Restore(Stream inputStream)

13
ExaArray/ExaArray2D.cs
View File

@ -8,6 +8,7 @@ namespace Exa
/// <summary> /// <summary>
/// The two-dimensional exa-scale array. Can grow up to 18,446,744,073,709,551,615 elements in total. /// The two-dimensional exa-scale array. Can grow up to 18,446,744,073,709,551,615 elements in total.
/// </summary> /// </summary>
[Serializable]
public sealed class ExaArray2D<T> : ISerializable public sealed class ExaArray2D<T> : ISerializable
{ {
/// <summary> /// <summary>
@ -86,9 +87,13 @@ namespace Exa
#region Store and load #region Store and load
/// <summary> /// <summary>
/// Stores the exa array into a stream. /// Stores the exa array into a stream. <b>Please read the remarks regarding security issues.</b>
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// The data stored in this way should never be part of a public API. Serializing and
/// deserializing is not secure: an attacker can manipulate the data in a targeted
/// manner to compromise the API server, etc.
///
/// This method does not dispose the stream. /// This method does not dispose the stream.
/// </remarks> /// </remarks>
public void Store(Stream outputStream) public void Store(Stream outputStream)
@ -98,9 +103,13 @@ namespace Exa
} }
/// <summary> /// <summary>
/// Restores an exa array from the given stream. /// Restores an exa array from the given stream. <b>Please read the remarks regarding security issues.</b>
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// The data loaded in this way should never be part of a public API. Serializing and
/// deserializing is not secure: an attacker can manipulate the data in a targeted
/// manner to compromise the API server, etc.
///
/// This method does not dispose the stream. /// This method does not dispose the stream.
/// </remarks> /// </remarks>
public static ExaArray2D<T> Restore(Stream inputStream) public static ExaArray2D<T> Restore(Stream inputStream)