Browse Source

Statistics: doc remarks on limited scope of DataContracts

pull/362/head
Christoph Ruegg 11 years ago
parent
commit
e2b1df7112
  1. 8
      src/Numerics/Statistics/DescriptiveStatistics.cs
  2. 6
      src/Numerics/Statistics/Histogram.cs
  3. 6
      src/Numerics/Statistics/RunningStatistics.cs

8
src/Numerics/Statistics/DescriptiveStatistics.cs

@ -39,8 +39,14 @@ namespace MathNet.Numerics.Statistics
/// NIST standard of accuracy for mean, variance, and standard deviation
/// (the only statistics they provide exact values for) and exceeds them
/// in increased accuracy mode.
/// Recommendation: consider to use RunningStatistics instead.
/// </summary>
/// <remarks>Consider to use RunningStatistics instead.</remarks>
/// <remarks>
/// This type declares a DataContract for out of the box ephemeral serialization
/// with engines like DataContractSerializer, Protocol Buffers and FsPickler,
/// but does not guarantee any compatibility between versions.
/// It is not recommended to rely on this mechanism for durable persistance.
/// </remarks>
[DataContract(Namespace = "urn:MathNet/Numerics")]
public class DescriptiveStatistics
{

6
src/Numerics/Statistics/Histogram.cs

@ -40,6 +40,12 @@ namespace MathNet.Numerics.Statistics
/// A <see cref="Histogram"/> consists of a series of <see cref="Bucket"/>s,
/// each representing a region limited by a lower bound (exclusive) and an upper bound (inclusive).
/// </summary>
/// <remarks>
/// This type declares a DataContract for out of the box ephemeral serialization
/// with engines like DataContractSerializer, Protocol Buffers and FsPickler,
/// but does not guarantee any compatibility between versions.
/// It is not recommended to rely on this mechanism for durable persistance.
/// </remarks>
[Serializable]
[DataContract(Namespace = "urn:MathNet/Numerics")]
public class Bucket :

6
src/Numerics/Statistics/RunningStatistics.cs

@ -41,6 +41,12 @@ namespace MathNet.Numerics.Statistics
/// Running statistics accumulator, allows updating by adding values
/// or by combining two accumulators.
/// </summary>
/// <remarks>
/// This type declares a DataContract for out of the box ephemeral serialization
/// with engines like DataContractSerializer, Protocol Buffers and FsPickler,
/// but does not guarantee any compatibility between versions.
/// It is not recommended to rely on this mechanism for durable persistance.
/// </remarks>
[DataContract(Namespace = "urn:MathNet/Numerics")]
public class RunningStatistics
{

Loading…
Cancel
Save