Source code for cvxpy.atoms.sum_squares

"""
Copyright 2013 Steven Diamond

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from typing import Optional, Tuple, Union

from cvxpy.atoms.quad_over_lin import quad_over_lin



[docs]
def sum_squares(
    expr,
    axis: Optional[Union[int, Tuple[int, ...]]] = None,
    keepdims: bool = False
):
    """The sum of the squares of the entries.

    Parameters
    ----------
    expr : Expression
        The expression to take the sum of squares of.
    axis : int or tuple of int, optional
        The axis or axes along which to compute the sum of squares.
        If None (default), sums over all elements and returns a scalar.
        If an int, sums over that axis.
        If a tuple, sums over multiple axes.
    keepdims : bool, optional
        If True, the reduced axes are retained as dimensions with size 1.
        Default is False.

    Returns
    -------
    Expression
        An expression representing the sum of squares.
        Scalar if axis is None, otherwise a vector/array (or with keepdims=True,
        retains shape with reduced dimensions as 1).
    """
    return quad_over_lin(expr, 1, axis=axis, keepdims=keepdims)