Skip to content

Commit 92fafd4

Browse files
authored
Allow passing const data to clustering functions (neoml-lib#458)
* Allow passing const data to clustering functions Signed-off-by: Peter Minin <petr.minin@abbyy.com> * Add `const` in examples Signed-off-by: Peter Minin <petr.minin@abbyy.com> * Update hierarchical dendrogram tests with `const` Signed-off-by: Peter Minin <petr.minin@abbyy.com> --------- Signed-off-by: Peter Minin <petr.minin@abbyy.com>
1 parent da06ff3 commit 92fafd4

20 files changed

Lines changed: 37 additions & 37 deletions

NeoML/docs/en/API/Clustering/FirstCome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The clustering parameters are described by the `CFirstComeClustering::CParam` s
2828
This sample shows how to use the first come clustering algorithm to clusterize the [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
2929

3030
```c++
31-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
31+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
3232
{
3333
CFirstComeClustering::CParam params;
3434
params.Threshold = 5;

NeoML/docs/en/API/Clustering/Hierarchical.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The clustering parameters are described by the `CHierarchicalClustering::CParam`
2727
In this sample an input data set is split into two clusters:
2828

2929
```c++
30-
void Clusterize( IClusteringData& data, CClusteringResult& result )
30+
void Clusterize( const IClusteringData& data, CClusteringResult& result )
3131
{
3232
CHierarchicalClustering::CParam params;
3333
params.DistanceType = DF_Euclid;

NeoML/docs/en/API/Clustering/ISODATA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The clustering parameters are described by the `CIsoDataClustering::CParam` stru
3131
This sample shows how to use the ISODATA algorithm to clusterize the [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
3232

3333
```c++
34-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
34+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
3535
{
3636
CIsoDataClustering::CParam params;
3737
params.InitialClustersCount = 1;

NeoML/docs/en/API/Clustering/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public:
6969
7070
// Clusterizes the input data
7171
// and returns true if successful with the given parameters
72-
virtual bool Clusterize( IClusteringData* data, CClusteringResult& result ) = 0;
72+
virtual bool Clusterize( const IClusteringData* data, CClusteringResult& result ) = 0;
7373
};
7474
```
7575

NeoML/docs/en/API/Clustering/kMeans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The clustering parameters are described by the `CKMeansClustering::CParam` struc
3535
This sample shows how to use the k-means algorithm to clusterize the [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
3636

3737
```c++
38-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
38+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
3939
{
4040
CKMeansClustering::CParam params;
4141
params.Algorithm = CKMeansClustering::KMA_Lloyd;

NeoML/docs/ru/API/Clustering/FirstCome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
В данном примере алгоритм по первому пришедшему используется для кластеризации набора данных [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
2929

3030
```c++
31-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
31+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
3232
{
3333
CFirstComeClustering::CParam params;
3434
params.Threshold = 5;

NeoML/docs/ru/API/Clustering/Hierarchical.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
В данном примере набор данных разбивается на два кластера:
2828

2929
```c++
30-
void Clusterize( IClusteringData& data, CClusteringResult& result )
30+
void Clusterize( const IClusteringData& data, CClusteringResult& result )
3131
{
3232
CHierarchicalClustering::CParam params;
3333
params.DistanceType = DF_Euclid;

NeoML/docs/ru/API/Clustering/ISODATA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
В данном примере алгоритм ISODATA используется для кластеризации набора данных [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
3232

3333
```c++
34-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
34+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
3535
{
3636
CIsoDataClustering::CParam params;
3737
params.InitialClustersCount = 1;

NeoML/docs/ru/API/Clustering/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public:
6969
7070
// Выполнить разбиение выборки на кластеры.
7171
// Возвращает true, если удалось успешно разбить данные на кластеры с заданными параметрами.
72-
virtual bool Clusterize( IClusteringData* data, CClusteringResult& result ) = 0;
72+
virtual bool Clusterize( const IClusteringData* data, CClusteringResult& result ) = 0;
7373
};
7474
```
7575

NeoML/docs/ru/API/Clustering/kMeans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
В данном примере алгоритм k-средних используется для кластеризации набора данных [Iris Data Set](http://archive.ics.uci.edu/ml/datasets/Iris):
3737

3838
```c++
39-
void Clusterize( IClusteringData& irisDataSet, CClusteringResult& result )
39+
void Clusterize( const IClusteringData& irisDataSet, CClusteringResult& result )
4040
{
4141
CKMeansClustering::CParam params;
4242
params.Algorithm = CKMeansClustering::KMA_Lloyd;

0 commit comments

Comments
 (0)