Mercurial > octave

comparison libinterp/corefcn/mappers.cc @ 30559:841a10208c38

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory. * data.cc, debug.cc, graphics.cc, mappers.cc, sparse.cc, strfns.cc, sysdep.cc, utils.cc, variables.cc, ov-cell.cc, ov-class.cc, ov-fcn-handle.cc, ov-java.cc, ov-null-mat.cc, ov-struct.cc, ov-usr-fcn.cc, ov.cc, octave.cc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory.
author Rik <rik@octave.org>
date Mon, 27 Dec 2021 19:53:35 -0800
parents c66cc7e61f84
children 83f9f8bda883
comparison
equal deleted inserted replaced
30558:83aeaba707d8 30559:841a10208c38
1011 %!error expm1 (1, 2) 1011 %!error expm1 (1, 2)
1012 */ 1012 */
1013 1013
1014 DEFUN (isfinite, args, , 1014 DEFUN (isfinite, args, ,
1015 doc: /* -*- texinfo -*- 1015 doc: /* -*- texinfo -*-
1016 @deftypefn {} {} isfinite (@var{x}) 1016 @deftypefn {} {@var{tf} =} isfinite (@var{x})
1017 Return a logical array which is true where the elements of @var{x} are 1017 Return a logical array which is true where the elements of @var{x} are
1018 finite values and false where they are not. 1018 finite values and false where they are not.
1019 1019
1020 For example: 1020 For example:
1021 1021
1213 %!error imag (1, 2) 1213 %!error imag (1, 2)
1214 */ 1214 */
1215 1215
1216 DEFUNX ("isalnum", Fisalnum, args, , 1216 DEFUNX ("isalnum", Fisalnum, args, ,
1217 doc: /* -*- texinfo -*- 1217 doc: /* -*- texinfo -*-
1218 @deftypefn {} {} isalnum (@var{s}) 1218 @deftypefn {} {@var{tf} =} isalnum (@var{s})
1219 Return a logical array which is true where the elements of @var{s} are 1219 Return a logical array which is true where the elements of @var{s} are
1220 letters or digits and false where they are not. 1220 letters or digits and false where they are not.
1221 1221
1222 This is equivalent to (@code{isalpha (@var{s}) | isdigit (@var{s})}). 1222 This is equivalent to (@code{isalpha (@var{s}) | isdigit (@var{s})}).
1223 @seealso{isalpha, isdigit, ispunct, isspace, iscntrl} 1223 @seealso{isalpha, isdigit, ispunct, isspace, iscntrl}
1243 %!error isalnum (1, 2) 1243 %!error isalnum (1, 2)
1244 */ 1244 */
1245 1245
1246 DEFUNX ("isalpha", Fisalpha, args, , 1246 DEFUNX ("isalpha", Fisalpha, args, ,
1247 doc: /* -*- texinfo -*- 1247 doc: /* -*- texinfo -*-
1248 @deftypefn {} {} isalpha (@var{s}) 1248 @deftypefn {} {@var{tf} =} isalpha (@var{s})
1249 Return a logical array which is true where the elements of @var{s} are 1249 Return a logical array which is true where the elements of @var{s} are
1250 letters and false where they are not. 1250 letters and false where they are not.
1251 1251
1252 This is equivalent to (@code{islower (@var{s}) | isupper (@var{s})}). 1252 This is equivalent to (@code{islower (@var{s}) | isupper (@var{s})}).
1253 @seealso{isdigit, ispunct, isspace, iscntrl, isalnum, islower, isupper} 1253 @seealso{isdigit, ispunct, isspace, iscntrl, isalnum, islower, isupper}
1272 %!error isalpha (1, 2) 1272 %!error isalpha (1, 2)
1273 */ 1273 */
1274 1274
1275 DEFUNX ("isascii", Fisascii, args, , 1275 DEFUNX ("isascii", Fisascii, args, ,
1276 doc: /* -*- texinfo -*- 1276 doc: /* -*- texinfo -*-
1277 @deftypefn {} {} isascii (@var{s}) 1277 @deftypefn {} {@var{tf} =} isascii (@var{s})
1278 Return a logical array which is true where the elements of @var{s} are 1278 Return a logical array which is true where the elements of @var{s} are
1279 ASCII characters (in the range 0 to 127 decimal) and false where they are 1279 ASCII characters (in the range 0 to 127 decimal) and false where they are
1280 not. 1280 not.
1281 @end deftypefn */) 1281 @end deftypefn */)
1282 { 1282 {
1296 %!error isascii (1, 2) 1296 %!error isascii (1, 2)
1297 */ 1297 */
1298 1298
1299 DEFUNX ("iscntrl", Fiscntrl, args, , 1299 DEFUNX ("iscntrl", Fiscntrl, args, ,
1300 doc: /* -*- texinfo -*- 1300 doc: /* -*- texinfo -*-
1301 @deftypefn {} {} iscntrl (@var{s}) 1301 @deftypefn {} {@var{tf} =} iscntrl (@var{s})
1302 Return a logical array which is true where the elements of @var{s} are 1302 Return a logical array which is true where the elements of @var{s} are
1303 control characters and false where they are not. 1303 control characters and false where they are not.
1304 @seealso{ispunct, isspace, isalpha, isdigit} 1304 @seealso{ispunct, isspace, isalpha, isdigit}
1305 @end deftypefn */) 1305 @end deftypefn */)
1306 { 1306 {
1322 %!error iscntrl (1, 2) 1322 %!error iscntrl (1, 2)
1323 */ 1323 */
1324 1324
1325 DEFUNX ("isdigit", Fisdigit, args, , 1325 DEFUNX ("isdigit", Fisdigit, args, ,
1326 doc: /* -*- texinfo -*- 1326 doc: /* -*- texinfo -*-
1327 @deftypefn {} {} isdigit (@var{s}) 1327 @deftypefn {} {@var{tf} =} isdigit (@var{s})
1328 Return a logical array which is true where the elements of @var{s} are 1328 Return a logical array which is true where the elements of @var{s} are
1329 decimal digits (0-9) and false where they are not. 1329 decimal digits (0-9) and false where they are not.
1330 @seealso{isxdigit, isalpha, isletter, ispunct, isspace, iscntrl} 1330 @seealso{isxdigit, isalpha, isletter, ispunct, isspace, iscntrl}
1331 @end deftypefn */) 1331 @end deftypefn */)
1332 { 1332 {
1348 %!error isdigit (1, 2) 1348 %!error isdigit (1, 2)
1349 */ 1349 */
1350 1350
1351 DEFUN (isinf, args, , 1351 DEFUN (isinf, args, ,
1352 doc: /* -*- texinfo -*- 1352 doc: /* -*- texinfo -*-
1353 @deftypefn {} {} isinf (@var{x}) 1353 @deftypefn {} {@var{tf} =} isinf (@var{x})
1354 Return a logical array which is true where the elements of @var{x} are 1354 Return a logical array which is true where the elements of @var{x} are
1355 infinite and false where they are not. 1355 infinite and false where they are not.
1356 1356
1357 For example: 1357 For example:
1358 1358
1391 %!error isinf (1, 2) 1391 %!error isinf (1, 2)
1392 */ 1392 */
1393 1393
1394 DEFUNX ("isgraph", Fisgraph, args, , 1394 DEFUNX ("isgraph", Fisgraph, args, ,
1395 doc: /* -*- texinfo -*- 1395 doc: /* -*- texinfo -*-
1396 @deftypefn {} {} isgraph (@var{s}) 1396 @deftypefn {} {@var{tf} =} isgraph (@var{s})
1397 Return a logical array which is true where the elements of @var{s} are 1397 Return a logical array which is true where the elements of @var{s} are
1398 printable characters (but not the space character) and false where they are 1398 printable characters (but not the space character) and false where they are
1399 not. 1399 not.
1400 @seealso{isprint} 1400 @seealso{isprint}
1401 @end deftypefn */) 1401 @end deftypefn */)
1418 %!error isgraph (1, 2) 1418 %!error isgraph (1, 2)
1419 */ 1419 */
1420 1420
1421 DEFUNX ("islower", Fislower, args, , 1421 DEFUNX ("islower", Fislower, args, ,
1422 doc: /* -*- texinfo -*- 1422 doc: /* -*- texinfo -*-
1423 @deftypefn {} {} islower (@var{s}) 1423 @deftypefn {} {@var{tf} =} islower (@var{s})
1424 Return a logical array which is true where the elements of @var{s} are 1424 Return a logical array which is true where the elements of @var{s} are
1425 lowercase letters and false where they are not. 1425 lowercase letters and false where they are not.
1426 @seealso{isupper, isalpha, isletter, isalnum} 1426 @seealso{isupper, isalpha, isletter, isalnum}
1427 @end deftypefn */) 1427 @end deftypefn */)
1428 { 1428 {
1444 %!error islower (1, 2) 1444 %!error islower (1, 2)
1445 */ 1445 */
1446 1446
1447 DEFUN (isna, args, , 1447 DEFUN (isna, args, ,
1448 doc: /* -*- texinfo -*- 1448 doc: /* -*- texinfo -*-
1449 @deftypefn {} {} isna (@var{x}) 1449 @deftypefn {} {@var{tf} =} isna (@var{x})
1450 Return a logical array which is true where the elements of @var{x} are 1450 Return a logical array which is true where the elements of @var{x} are
1451 NA (missing) values and false where they are not. 1451 NA (missing) values and false where they are not.
1452 1452
1453 For example: 1453 For example:
1454 1454
1486 %!error isna (1, 2) 1486 %!error isna (1, 2)
1487 */ 1487 */
1488 1488
1489 DEFUN (isnan, args, , 1489 DEFUN (isnan, args, ,
1490 doc: /* -*- texinfo -*- 1490 doc: /* -*- texinfo -*-
1491 @deftypefn {} {} isnan (@var{x}) 1491 @deftypefn {} {@var{tf} =} isnan (@var{x})
1492 Return a logical array which is true where the elements of @var{x} are 1492 Return a logical array which is true where the elements of @var{x} are
1493 NaN values and false where they are not. 1493 NaN values and false where they are not.
1494 1494
1495 NA values are also considered NaN values. For example: 1495 NA values are also considered NaN values. For example:
1496 1496
1529 %!error isnan (1, 2) 1529 %!error isnan (1, 2)
1530 */ 1530 */
1531 1531
1532 DEFUNX ("isprint", Fisprint, args, , 1532 DEFUNX ("isprint", Fisprint, args, ,
1533 doc: /* -*- texinfo -*- 1533 doc: /* -*- texinfo -*-
1534 @deftypefn {} {} isprint (@var{s}) 1534 @deftypefn {} {@var{tf} =} isprint (@var{s})
1535 Return a logical array which is true where the elements of @var{s} are 1535 Return a logical array which is true where the elements of @var{s} are
1536 printable characters (including the space character) and false where they 1536 printable characters (including the space character) and false where they
1537 are not. 1537 are not.
1538 @seealso{isgraph} 1538 @seealso{isgraph}
1539 @end deftypefn */) 1539 @end deftypefn */)
1556 %!error isprint (1, 2) 1556 %!error isprint (1, 2)
1557 */ 1557 */
1558 1558
1559 DEFUNX ("ispunct", Fispunct, args, , 1559 DEFUNX ("ispunct", Fispunct, args, ,
1560 doc: /* -*- texinfo -*- 1560 doc: /* -*- texinfo -*-
1561 @deftypefn {} {} ispunct (@var{s}) 1561 @deftypefn {} {@var{tf} =} ispunct (@var{s})
1562 Return a logical array which is true where the elements of @var{s} are 1562 Return a logical array which is true where the elements of @var{s} are
1563 punctuation characters and false where they are not. 1563 punctuation characters and false where they are not.
1564 @seealso{isalpha, isdigit, isspace, iscntrl} 1564 @seealso{isalpha, isdigit, isspace, iscntrl}
1565 @end deftypefn */) 1565 @end deftypefn */)
1566 { 1566 {
1585 %!error ispunct (1, 2) 1585 %!error ispunct (1, 2)
1586 */ 1586 */
1587 1587
1588 DEFUNX ("isspace", Fisspace, args, , 1588 DEFUNX ("isspace", Fisspace, args, ,
1589 doc: /* -*- texinfo -*- 1589 doc: /* -*- texinfo -*-
1590 @deftypefn {} {} isspace (@var{s}) 1590 @deftypefn {} {@var{tf} =} isspace (@var{s})
1591 Return a logical array which is true where the elements of @var{s} are 1591 Return a logical array which is true where the elements of @var{s} are
1592 whitespace characters (space, formfeed, newline, carriage return, tab, and 1592 whitespace characters (space, formfeed, newline, carriage return, tab, and
1593 vertical tab) and false where they are not. 1593 vertical tab) and false where they are not.
1594 @seealso{iscntrl, ispunct, isalpha, isdigit} 1594 @seealso{iscntrl, ispunct, isalpha, isdigit}
1595 @end deftypefn */) 1595 @end deftypefn */)
1612 %!error isspace (1, 2) 1612 %!error isspace (1, 2)
1613 */ 1613 */
1614 1614
1615 DEFUNX ("isupper", Fisupper, args, , 1615 DEFUNX ("isupper", Fisupper, args, ,
1616 doc: /* -*- texinfo -*- 1616 doc: /* -*- texinfo -*-
1617 @deftypefn {} {} isupper (@var{s}) 1617 @deftypefn {} {@var{tf} =} isupper (@var{s})
1618 Return a logical array which is true where the elements of @var{s} are 1618 Return a logical array which is true where the elements of @var{s} are
1619 uppercase letters and false where they are not. 1619 uppercase letters and false where they are not.
1620 @seealso{islower, isalpha, isletter, isalnum} 1620 @seealso{islower, isalpha, isletter, isalnum}
1621 @end deftypefn */) 1621 @end deftypefn */)
1622 { 1622 {
1638 %!error isupper (1, 2) 1638 %!error isupper (1, 2)
1639 */ 1639 */
1640 1640
1641 DEFUNX ("isxdigit", Fisxdigit, args, , 1641 DEFUNX ("isxdigit", Fisxdigit, args, ,
1642 doc: /* -*- texinfo -*- 1642 doc: /* -*- texinfo -*-
1643 @deftypefn {} {} isxdigit (@var{s}) 1643 @deftypefn {} {@var{tf} =} isxdigit (@var{s})
1644 Return a logical array which is true where the elements of @var{s} are 1644 Return a logical array which is true where the elements of @var{s} are
1645 hexadecimal digits (0-9 and @nospell{a-fA-F}). 1645 hexadecimal digits (0-9 and @nospell{a-fA-F}).
1646 @seealso{isdigit} 1646 @seealso{isdigit}
1647 @end deftypefn */) 1647 @end deftypefn */)
1648 { 1648 {