@@ -352,28 +352,44 @@ class BiclusterMixin(object):
352
352
353
353
@property
354
354
def biclusters_ (self ):
355
- """Convenient way to get row and column indicators together."""
355
+ """Convenient way to get row and column indicators together.
356
+
357
+ Returns the ``rows_`` and ``columns_`` members.
358
+ """
356
359
return self .rows_ , self .columns_
357
360
358
361
def get_indices (self , i ):
359
- """Returns the row and column indices of bicluster `i`.
362
+ """Row and column indices of the i'th bicluster.
363
+
364
+ Only works if ``rows_`` and ``columns_`` attributes exist.
360
365
361
- Only works if ``rows_`` and ``columns`` attributes exist.
366
+ Returns
367
+ -------
368
+ row_ind : np.array, dtype=np.intp
369
+ Indices of rows in the dataset that belong to the bicluster.
370
+ col_ind : np.array, dtype=np.intp
371
+ Indices of columns in the dataset that belong to the bicluster.
362
372
363
373
"""
364
374
from .cluster .bicluster .utils import get_indices
365
375
return get_indices (self .rows_ [i ], self .columns_ [i ])
366
376
367
377
def get_shape (self , i ):
368
- """Returns shape of bicluster `i`."""
378
+ """Shape of the i'th bicluster.
379
+
380
+ Returns
381
+ -------
382
+ shape : (int, int)
383
+ Number of rows and columns (resp.) in the bicluster.
384
+ """
369
385
from .cluster .bicluster .utils import get_shape
370
386
return get_shape (self .rows_ [i ], self .columns_ [i ])
371
387
372
388
def get_submatrix (self , i , data ):
373
389
"""Returns the submatrix corresponding to bicluster `i`.
374
390
375
391
Works with sparse matrices. Only works if ``rows_`` and
376
- ``columns `` attributes exist.
392
+ ``columns_ `` attributes exist.
377
393
378
394
"""
379
395
from .cluster .bicluster .utils import get_submatrix
0 commit comments