bugGNU Octave - Bugs: bug #66595, The qz function documentation was...

 
 

bug #66595: The qz function documentation was not updated with generalized eigenvalues are no longer returned

Submitter:  None
Submitted:  Tue 24 Dec 2024 06:57:46 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  In Progress Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Open Release:  * 9.3.0
Operating System:  * Any Fixed Release:  None
Planned Release:  10.1.0 (current default)
* Mandatory Fields

Add a New Comment Rich Markup
   

Fri 03 Jan 2025 02:35:05 PM UTC, comment #5: 

comment #3:

> Thanks.  I started to apply your patch and realized that the entire qz documentation needs review.  Some of the statements are just wrong.  For example, the docs say
>


> AA = Q'*A*Z


>
> But, the actual relation as documented by Matlab and verified in Octave is
>


> AA = Q*A*Z


>
> Unfortunately, this is going to take longer than I thought.


I have uploaded the modified patch ensuring no incorrect information in the qz documentation exists. The latest uploaded patch includes all the necessary changes, please review it when you have a chance.

Thank You for your time and support.
Swayam (Sonu0305)

Sonu0305 <swayamshah>
Wed 01 Jan 2025 07:46:48 PM UTC, comment #4: 

I'll upload a new patch with all correct documentation, soon.
Thank you for your time and support.
Swayam (Sonu0305)

 Sonu0305 <swayamshah>
Wed 01 Jan 2025 05:39:21 PM UTC, comment #3: 

Thanks.  I started to apply your patch and realized that the entire qz documentation needs review.  Some of the statements are just wrong.  For example, the docs say


AA = Q'*A*Z


But, the actual relation as documented by Matlab and verified in Octave is


AA = Q*A*Z


Unfortunately, this is going to take longer than I thought.

 Rik <rik5>
Group administrator
Wed 01 Jan 2025 11:44:00 AM UTC, comment #2: 

comment #1:

> Confirmed.
>
> The qz() documentation could use updating.  Is it possible for you to prepare a changeset or patch file?


I have attached a patch file including the necessary changes.

Thank You
Swayam (Sonu0305)

 Sonu0305 <swayamshah>
Sat 28 Dec 2024 10:59:09 PM UTC, comment #1: 

Confirmed.

The qz() documentation could use updating.  Is it possible for you to prepare a changeset or patch file?

 Rik <rik5>
Group administrator
Tue 24 Dec 2024 06:57:46 AM UTC, original submission:  

The top of the doc is aligned with how it can be called:
-- [AA, BB, Q, Z, V, W] = qz (A, B)
-- [AA, BB, Q, Z, V, W] = qz (A, B, OPT)

However, the docs state later:

"There are two calling forms of the function:

       1. ‘[AA, BB, Q, Z, V, W, LAMBDA] = qz (A, B)’"

but LAMBDA is no longer returned.

It would be nice to mention ordeig can be used to get the eigenvalues LAMBDA.



Anonymous

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #56738:  0001-qz-documentation-updated.patch added by swayamshah (2KiB - application/octet-stream)
file #56731:  0001-qz-function-documentation-updated.patch added by swayamshah (2KiB - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by swayamshah (Updated the item)
  • -email is unavailable- added by rik5 (Posted a comment)

    •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2025-01-03 swayamshah Attached File- Added 0001-qz-documentation-updated.patch, #56738
    2025-01-01 rik5 StatusConfirmed In Progress
    2024-12-31 swayamshah Attached File- Added 0001-qz-function-documentation-updated.patch, #56731
    2024-12-28 rik5 CategoryOctave Function Documentation
        StatusNone Confirmed
        Planned ReleaseNone 10.1.0 (current default)

    Back to the top

    Copyright © 2025 Free Software Foundation, Inc.
    Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.
    The Levitating, Meditating, Flute-playing Gnu logo is a GNU GPL'ed image provided by the Nevrax Design Team.
    Page source code

    Powered by Savane 3.14-708e.
    Corresponding source code