Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More web doc updates #1732

Merged
merged 4 commits into from
Apr 3, 2022
Merged

Conversation

rileyjmurray
Copy link
Collaborator

Documentation for the following functions was missing from https://www.cvxpy.org/tutorial/functions/index.html:

  • conj
  • imag
  • real
  • upper_tri

This PR adds that documentation. It also ...

  1. updates that page to reflect how kron can accept Variables in either argument,
  2. explains how signs are determined when applying vector/matrix atoms (the table was incorrect).

@rileyjmurray rileyjmurray merged commit 4321100 into cvxpy:release/1.2.x Apr 3, 2022
The output :math:`X'` of ``reshape(X, (m', n'))`` is the matrix :math:`X` cast into an :math:`m' \times n'` matrix.
The entries are taken from :math:`X` in column-major order and stored in :math:`X'` in column-major order.
Formally, :math:`X'_{ij} = \mathbf{vec}(X)_{m'j + i}`.
The output :math:`y = \mathbf{upper\_tri}(X)` is formed by concatenating partial rows of :math:`X`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think upper_tri can include or exclude the diagonal based on a flag.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's just the strict upper triangle. There's a helper function in upper_tri.py called vec_to_upper_tri which supports a flag, but there isn't an analogous function for going the other way.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be a nice feature improvement

@rileyjmurray
Copy link
Collaborator Author

@SteveDiamond have you looked over all the changes? If so then I'll commit the fixes directly to release/1.2.x.

@SteveDiamond
Copy link
Collaborator

Yeah, looks good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants