# Copyright 1999-2021 Alibaba Group Holding Ltd.
#
# 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.

import numpy as np

from ... import opcodes as OperandDef
from ...utils import classproperty
from .core import DataFrameBinopUfunc
from .docstring import bin_compare_doc


class DataFrameNotEqual(DataFrameBinopUfunc):
    _op_type_ = OperandDef.NE

    _func_name = "ne"
    _rfunc_name = "ne"

    return_dtype = np.dtype(bool)

    @classproperty
    def _operator(self):
        return lambda lhs, rhs: lhs.ne(rhs)

    @classproperty
    def tensor_op_type(self):
        from ...tensor.arithmetic import TensorNotEqual

        return TensorNotEqual


_ne_example = """
>>> a.ne(b, fill_value=0).execute()
a    False
b     True
c     True
d     True
e     True
dtype: bool
"""


@bin_compare_doc("Not equal to", equiv="!=", series_example=_ne_example)
def ne(df, other, axis="columns", level=None):
    op = DataFrameNotEqual(axis=axis, level=level, lhs=df, rhs=other)
    return op(df, other)
