Mercurial > hg > octave-lyh

comparison src/help.cc @ 14169:c0ca47ab7641 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Better explain which complex result is chosen by .^ * expr.txi: Explain which complex root is chosen and how to choose a real one if preferred. * data.cc (power): Ditto. * help.cc (.^, .**): Ditto. (^, **): Suggest using real-valued functions.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Sun, 08 Jan 2012 15:24:53 -0500
parents 72c96de7a403
children 2ced2f59f523
comparison
equal deleted inserted replaced
14168:7ffd2a0791ef 14169:c0ca47ab7641
237 @end deftypefn"), 237 @end deftypefn"),
238 238
239 pair_type ("**", 239 pair_type ("**",
240 "-*- texinfo -*-\n\ 240 "-*- texinfo -*-\n\
241 @deftypefn {Operator} {} **\n\ 241 @deftypefn {Operator} {} **\n\
242 Power operator.\n\ 242 Power operator. This may return complex results for real inputs. Use\n\
243 @seealso{power, ^, .**, .^}\n\ 243 @code{realsqrt}, @code{cbrt}, @code{nthroot}, or @code{realroot} to obtain\n\
244 real results when possible.\n\
245 @seealso{power, ^, .**, .^, realpow, realsqrt, cbrt, nthroot}\n\
244 @end deftypefn"), 246 @end deftypefn"),
245 247
246 pair_type ("^", 248 pair_type ("^",
247 "-*- texinfo -*-\n\ 249 "-*- texinfo -*-\n\
248 @deftypefn {Operator} {} ^\n\ 250 @deftypefn {Operator} {} ^\n\
249 Power operator.\n\ 251 Power operator. This may return complex results for real inputs. Use\n\
250 @seealso{power, **, .^, .**}\n\ 252 @code{realsqrt}, @code{cbrt}, @code{nthroot}, or @code{realroot} to obtain\n\
253 real results when possible.\n\
254 @seealso{power, **, .^, .**, realpow, realsqrt, cbrt, nthroot}\n\
251 @end deftypefn"), 255 @end deftypefn"),
252 256
253 pair_type ("+", 257 pair_type ("+",
254 "-*- texinfo -*-\n\ 258 "-*- texinfo -*-\n\
255 @deftypefn {Operator} {} +\n\ 259 @deftypefn {Operator} {} +\n\
302 @end deftypefn"), 306 @end deftypefn"),
303 307
304 pair_type (".**", 308 pair_type (".**",
305 "-*- texinfo -*-\n\ 309 "-*- texinfo -*-\n\
306 @deftypefn {Operator} {} .*\n\ 310 @deftypefn {Operator} {} .*\n\
307 Element by element power operator.\n\ 311 Element by element power operator. If several complex results are possible,\n\
308 @seealso{**, ^, .^, power}\n\ 312 returns the one with smallest nonnegative argument (angle). Use\n\
313 @code{realpow}, @code{realsqrt}, @code{cbrt}, or @code{nthroot} if a\n\
314 real result is preferred.\n\
315 @seealso{**, ^, .^, power, realpow, realsqrt, cbrt, nthroot}\n\
309 @end deftypefn"), 316 @end deftypefn"),
310 317
311 pair_type (".^", 318 pair_type (".^",
312 "-*- texinfo -*-\n\ 319 "-*- texinfo -*-\n\
313 @deftypefn {Operator} {} .^\n\ 320 @deftypefn {Operator} {} .^\n\
314 Element by element power operator.\n\ 321 Element by element power operator. If several complex results are possible,\n\
315 @seealso{.**, ^, **, power}\n\ 322 returns the one with smallest nonnegative argument (angle). Use\n\
323 @code{realpow}, @code{realsqrt}, @code{cbrt}, or @code{nthroot} if a\n\
324 real result is preferred.\n\
325 @seealso{.**, ^, **, power, realpow, realsqrt, cbrt, nthroot}\n\
316 @end deftypefn"), 326 @end deftypefn"),
317 327
318 pair_type ("./", 328 pair_type ("./",
319 "-*- texinfo -*-\n\ 329 "-*- texinfo -*-\n\
320 @deftypefn {Operator} {} ./\n\ 330 @deftypefn {Operator} {} ./\n\