# Source code for cvxpy.atoms.norm_nuc

"""

you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
"""

from cvxpy.atoms.atom import Atom
import numpy as np
import scipy.sparse as sp

[docs]class normNuc(Atom):
"""Sum of the singular values.
"""
_allow_complex = True

def __init__(self, A):
super(normNuc, self).__init__(A)

def numeric(self, values):
"""Returns the nuclear norm (i.e. the sum of the singular values) of A.
"""
return np.linalg.norm(values[0], 'nuc')

"""Gives the (sub/super)gradient of the atom w.r.t. each argument.

Matrix expressions are vectorized, so the gradient is a matrix.

Args:
values: A list of numeric values for the arguments.

Returns:
A list of SciPy CSC sparse matrices or None.
"""
U, _, V = np.linalg.svd(values[0])
D = U.dot(V)
return [sp.csc_matrix(D.ravel(order='F')).T]

def shape_from_args(self):
"""Returns the (row, col) shape of the expression.
"""
return tuple()

def sign_from_args(self):
"""Returns sign (is positive, is negative) of the expression.
"""
return (True, False)

def is_atom_convex(self):
"""Is the atom convex?
"""
return True

def is_atom_concave(self):
"""Is the atom concave?
"""
return False

def is_incr(self, idx):
"""Is the composition non-decreasing in argument idx?
"""
return False

def is_decr(self, idx):
"""Is the composition non-increasing in argument idx?
"""
return False