bugGNU Octave - Bugs: bug #48088, document that issquare, iscolumn,...

 
 

bug #48088: document that issquare, iscolumn, isempty, etc operate on cell arrays

Submitted by:  Francesco Potortì <pot>
Submitted on:  Thu 02 Jun 2016 11:26:40 AM UTC  
 
Category: DocumentationSeverity: 2 - Minor
Priority: 3 - LowItem Group: Documentation
Status: ConfirmedAssigned to: None
Originator Name: Open/Closed: Open
Release: 4.0.2Operating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Fri 24 Jun 2016 03:41:24 PM UTC, comment #4:

Well, certainly the word "matrix" should either removed from the help or accompanied by other possible types to which issquare applies.

Ideally, I would like to find something along these lines:

return true if X is square.
X can be a matrix, cell array or any other type for which size(X) returns [r, c] with r == c.

Maybe your proposal is good as well.

Francesco Potortì <pot>
Fri 24 Jun 2016 04:43:00 AM UTC, comment #3:

The Matlab documentation often lists the types a function can be applied to.

However, "help isrow" for example, simply gives the definition in terms of "size", without mentioning whether the argument is a matrix, a cell array or a class object.

Perhaps "issquare" could say
Return true of X has size(X) = [r, c] with r == c.

Francesco, would that be sufficient for you?

Lachlan Andrew <lachlan>
Project Member
Thu 02 Jun 2016 03:13:16 PM UTC, comment #2:

Should be briefly mentioned in all functions. The way I use the documentation, it would be almost useless otherwise.

Francesco Potortì <pot>
Thu 02 Jun 2016 02:42:04 PM UTC, comment #1:

This applies to all the "shape" functions, isempty, isrow, iscolumn, issquare, ismatrix, isvector, etc.

Should each function have to mention cell arrays? Or should the documentation section on cell arrays say something like "many functions that operate on matrices also apply to cell arrays")?

Mike Miller <mtmiller>
Project Administrator
Thu 02 Jun 2016 11:26:40 AM UTC, original submission:

> help issquare

'issquare' is a built-in function from the file libinterp/corefcn/data.cc

-- Function File: issquare (X)
Return true if X is a square matrix.

See also: isscalar, isvector, ismatrix, size.

Francesco Potortì <pot>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by lachlan (Posted a comment)
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by siko1056 (Updated the item)
  • -unavailable- added by pot (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 4 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 02 Jun 2016 02:42:53 PM UTCmtmillerSummaryDocs from issquare() should mention that it works for cell arrays too.=>document that issquare, iscolumn, isempty, etc operate on cell arrays
    Thu 02 Jun 2016 02:42:04 PM UTCmtmillerSeverity3 - Normal=>2 - Minor
    Thu 02 Jun 2016 02:11:51 PM UTCsiko1056Priority5 - Normal=>3 - Low
      StatusNone=>Confirmed

    Back to the top


    Powered by Savane 3.1-cleanup1