Skip to content

Commit c35634a

Browse files
committed
[minors] Doc typos
1 parent 3e8dc2f commit c35634a

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

commpy/modulation.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,19 +213,24 @@ def kbest(y, h, constellation, K):
213213
Reference: Zhan Guo and P. Nilsson, 'Algorithm and implementation of the K-best sphere decoding for MIMO detection',
214214
IEEE Journal on Selected Areas in Communications, vol. 24, no. 3, pp. 491-503, Mar. 2006.
215215
216-
parameters
216+
Parameters
217217
----------
218-
y : 1D ndarray of floats
219-
Received complex symbols (shape: num_receive_antennas x 1)
218+
y : 1D ndarray
219+
Received complex symbols (length: num_receive_antennas)
220220
221-
h : 2D ndarray of floats
221+
h : 2D ndarray
222222
Channel Matrix (shape: num_receive_antennas x num_transmit_antennas)
223223
224224
constellation : 1D ndarray of floats
225225
Constellation used to modulate the symbols
226226
227227
K : positive integer
228228
Number of candidates kept at each step
229+
230+
Returns
231+
-------
232+
x : 1D ndarray of constellation points
233+
Detected vector (length: num_receive_antennas)
229234
"""
230235
# QR decomposition
231236
q, r = qr(h)

0 commit comments

Comments
 (0)