Skip to content

Commit cddf934

Browse files
committed
Fixed comments
1 parent e1cc597 commit cddf934

File tree

4 files changed

+17
-19
lines changed

4 files changed

+17
-19
lines changed

src/Library.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public static class Library
2222
public enum Backend
2323
{
2424
/// <summary>
25-
/// DEFAULT Backend
25+
/// DEFAULT Backend.
2626
/// </summary>
2727
// ReSharper disable once UnusedMember.Global
2828
KhivaBackendDefault = 0,
@@ -44,7 +44,7 @@ public enum Backend
4444
}
4545

4646
/// <summary>
47-
/// Getters and setters for the Khiva backend
47+
/// Getters and setters for the Khiva backend.
4848
/// </summary>
4949
public static Backend CurrentBackend
5050
{
@@ -61,7 +61,7 @@ public static Backend CurrentBackend
6161
}
6262

6363
/// <summary>
64-
/// Supported Khiva backends
64+
/// Supported Khiva backends.
6565
/// </summary>
6666
public static Backend SupportedBackends
6767
{
@@ -96,7 +96,7 @@ public static string BackendInfo
9696
}
9797

9898
/// <summary>
99-
/// Getter and setter for the Khiva device
99+
/// Getter and setter for the Khiva device.
100100
/// </summary>
101101
public static int Device
102102
{
@@ -109,7 +109,7 @@ public static int Device
109109
}
110110

111111
/// <summary>
112-
/// Getter for the device count
112+
/// Getter for the device count.
113113
/// </summary>
114114
public static int DeviceCount
115115
{
@@ -121,7 +121,7 @@ public static int DeviceCount
121121
}
122122

123123
/// <summary>
124-
/// Getter for the Khiva version
124+
/// Getter for the Khiva version.
125125
/// </summary>
126126
public static string Version
127127
{

src/Matrix.cs

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ public static class Matrix
1717
/// <summary>
1818
/// Primitive of the findBestNDiscords function.
1919
/// </summary>
20-
/// <param name="profile">The matrix profile containing the minimum distance of each subsequence</param>
21-
/// <param name="index">The matrix profile index containing the index of the most similar subsequence</param>
22-
/// <param name="m">Length of the matrix profile</param>
23-
/// <param name="n">Number of discords to extract</param>
20+
/// <param name="profile">The matrix profile containing the minimum distance of each subsequence.</param>
21+
/// <param name="index">The matrix profile index containing the index of the most similar subsequence.</param>
22+
/// <param name="m">Length of the matrix profile.</param>
23+
/// <param name="n">Number of discords to extract.</param>
2424
/// <param name="selfJoin">Indicates whether the input profile comes from a self join operation or not. It determines
2525
/// whether the mirror similar region is included in the output or not.</param>
2626
/// <returns>Tuple with the distance of the best N discords, the indices of the best N discords and
@@ -78,9 +78,8 @@ public static Tuple<KhivaArray, KhivaArray, KhivaArray> FindBestNMotifs(KhivaArr
7878
/// <param name="tssa">Query time series.</param>
7979
/// <param name="tssb">Reference time series.</param>
8080
/// <param name="m">Pointer to a long with the length of the subsequence.</param>
81-
/// <returns>Tuple with
82-
/// the matrix profile, which has the distance to the closer element of the subsequence from 'tssa' in 'tssb' and
83-
/// the matrix profile index, which points to where the aforementioned minimum is located.</returns>
81+
/// <returns>Tuple with the matrix profile, which has the distance to the closer element of the subsequence from
82+
/// 'tssa' in 'tssb' and the matrix profile index, which points to where the aforementioned minimum is located.</returns>
8483
public static Tuple<KhivaArray, KhivaArray> Stomp(KhivaArray tssa, KhivaArray tssb, long m)
8584
{
8685
var aReference = tssa.Reference;
@@ -103,9 +102,9 @@ public static Tuple<KhivaArray, KhivaArray> Stomp(KhivaArray tssa, KhivaArray ts
103102
/// </summary>
104103
/// <param name="tss">Query and reference time series.</param>
105104
/// <param name="m">Pointer to a long with the length of the subsequence.</param>
106-
/// <returns>Tuple with
107-
/// the matrix profile, which has the distance to the closer element of the subsequence from 'tss' in a different location of itself and
108-
/// the matrix profile index, which points to where the aforementioned minimum is located.</returns>
105+
/// <returns>Tuple with the matrix profile, which has the distance to the closer element of the subsequence from
106+
/// 'tss' in a different location of itself and the matrix profile index, which points to where the aforementioned
107+
/// minimum is located.</returns>
109108
public static Tuple<KhivaArray, KhivaArray> StompSelfJoin(KhivaArray tss, long m)
110109
{
111110
var reference = tss.Reference;

src/Regression.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ public static class Regression
2424
/// one indicates the number of time series.</param>
2525
/// <returns>Tuple with the slope of the regression line, the correlation coefficient,
2626
/// the two-sided p-value for a hypothesis test whose null hypothesis is that the slope is zero, using Wald
27-
/// Test with t-distribution of the test statistic and
28-
/// the standard error of the estimated gradient.</returns>
27+
/// Test with t-distribution of the test statistic and the standard error of the estimated gradient.</returns>
2928
public static Tuple<KhivaArray, KhivaArray, KhivaArray, KhivaArray, KhivaArray> Linear(KhivaArray xss,
3029
KhivaArray yss)
3130
{

src/Regularization.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public static class Regularization
3232
/// }
3333
///</param>
3434
/// <param name="nColumnsKey">Number of columns conforming the key.</param>
35-
/// <param name="nColumnsValue">Number of columns conforming the value (they are expected to be consecutive to the column</param>
35+
/// <param name="nColumnsValue">Number of columns conforming the value (they are expected to be consecutive to the column.</param>
3636
/// <returns>An array with the values of the group keys aggregated using the aggregation_function.</returns>
3737
public static KhivaArray GroupBy(KhivaArray array, int aggregationFunction, int nColumnsKey = 1,
3838
int nColumnsValue = 1)

0 commit comments

Comments
 (0)