* Copyright (c) 2025 Huawei Technologies Co., Ltd.
* This program is free software, you can redistribute it and/or modify it under the terms and conditions of
* CANN Open Software License Agreement Version 2.0 (the "License").
* Please refer to the License for details. You may not use this file except in compliance with the License.
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
* See LICENSE in the root of the software repository for the full text of the License.
*/
#ifndef OP_API_INC_BITWISE_AND_SCALAR_H_
#define OP_API_INC_BITWISE_AND_SCALAR_H_
#include "aclnn/aclnn_base.h"
#include "aclnn_util.h"
#ifdef __cplusplus
extern "C" {
#endif
* @brief aclnnBitwiseAndScalar的第一段接口，根据具体的计算流程，计算workspace大小。
* @domain aclnn_math
*
* 算子功能：完成位与或者逻辑与计算
* 计算公式：
* $$ output_i = self_i\&other_i $$
*
* 实现说明
* 计算图一
* 场景一：经过类型推导后，self和other的数据类型都为BOOL类型时，需要调用l0::LogicalAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([LogicalAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
* 计算图二
* 场景二：经过类型推导后，self和other的数据类型都为INT类型时，需要调用l0::BitwiseAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([BitwiseAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
*
* @param [in] self: npu device侧的aclTensor，数据类型支持INT16,UINT16,INT32,INT64,INT8,UINT8,BOOL，
* 且数据类型需要与other构成互相推导关系，支持非连续的Tensor，数据格式支持ND。
* @param [in] other:
* host侧的aclScalar，数据类型支持INT16,UINT16,INT32,INT64,INT8,UINT8,BOOL，且数据类型需要与self构成互相推导关系。
* @param [in] out: npu device侧的aclTensor，数据类型支持INT16,UINT16,INT32,INT64,INT8,UINT8,BOOL，
* 且数据类型需要是self与other推导之后可转换的数据类型，shape与self一致，数据格式支持ND，支持非连续的Tensor。
* @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
* @param [out] executor: 返回op执行器，包含算子计算流程。
* @return aclnnStatus: 返回状态码。
*/
ACLNN_API aclnnStatus aclnnBitwiseAndScalarGetWorkspaceSize(const aclTensor* self, const aclScalar* other,
aclTensor* out, uint64_t* workspaceSize,
aclOpExecutor** executor);
* @brief aclnnBitwiseAndScalar的第二段接口，用于执行计算。
*
* 算子功能：完成位与或者逻辑与计算
* 计算公式：
* $$ output_i = self_i\&other_i $$
*
* 实现说明
* 计算图一
* 场景一：经过类型推导后，self和other的数据类型都为BOOL类型时，需要调用l0::LogicalAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([LogicalAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
* 计算图二
* 场景二：经过类型推导后，self和other的数据类型都为INT类型时，需要调用l0::BitwiseAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([BitwiseAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
*
* @param [in] workspace: 在npu device侧申请的workspace内存起址。
* @param [in] workspace_size: 在npu
* device侧申请的workspace大小，由第一段接口aclnnBitwiseAndScalarGetWorkspaceSize获取。
* @param [in] executor: op执行器，包含了算子计算流程。
* @param [in] stream: acl stream流。
* @return aclnnStatus: 返回状态码。
*/
ACLNN_API aclnnStatus aclnnBitwiseAndScalar(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor,
aclrtStream stream);
* @brief aclnnInplaceBitwiseAndScalar的第一段接口，根据具体的计算流程，计算workspace大小。
* @domain aclnn_math
*
* 算子功能：完成位与或者逻辑与计算
* 计算公式：
* $$ output_i = self_i\&other_i $$
*
* 实现说明
* 计算图一
* 场景一：经过类型推导后，self和other的数据类型都为BOOL类型时，需要调用l0::LogicalAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([LogicalAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
* 计算图二
* 场景二：经过类型推导后，self和other的数据类型都为INT类型时，需要调用l0::BitwiseAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([BitwiseAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
*
* @param [in] self: npu device侧的aclTensor，数据类型支持INT16,UINT16,INT32,INT64,INT8,UINT8,BOOL，
* 且数据类型需要与other构成互相推导关系，支持非连续的Tensor，数据格式支持ND。
* @param [in] other:
* host侧的aclScalar，数据类型支持INT16,UINT16,INT32,INT64,INT8,UINT8,BOOL，且数据类型需要与self构成互相推导关系。
* @param [out] workspaceSize: 返回用户需要在npu device侧申请的workspace大小。
* @param [out] executor: 返回op执行器，包含算子计算流程。
* @return aclnnStatus: 返回状态码。
*/
ACLNN_API aclnnStatus aclnnInplaceBitwiseAndScalarGetWorkspaceSize(const aclTensor* selfRef, const aclScalar* other,
uint64_t* workspaceSize, aclOpExecutor** executor);
* @brief aclnnInplaceBitwiseAndScalar的第二段接口，用于执行计算。
*
* 算子功能：完成位与或者逻辑与计算
* 计算公式：
* $$ output_i = self_i\&other_i $$
*
* 实现说明
* 计算图一
* 场景一：经过类型推导后，self和other的数据类型都为BOOL类型时，需要调用l0::LogicalAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([LogicalAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
* 计算图二
* 场景二：经过类型推导后，self和other的数据类型都为INT类型时，需要调用l0::BitwiseAnd接口做计算：
* ```mermaid
* graph LR
* A[(Self)] -->B([Contiguous])
* B --> C([Cast])
* C --> G([BitwiseAnd])
* D[(other)] -->G
* G --> H([Cast])
* H --> I([ViewCopy])
* I --> J[(out)]
* ```
*
* @param [in] workspace: 在npu device侧申请的workspace内存起址。
* @param [in] workspaceSize: 在npu
* device侧申请的workspace大小，由第一段接口aclnnInplaceBitwiseAndScalarGetWorkspaceSize获取。
* @param [in] executor: op执行器，包含了算子计算流程。
* @param [in] stream: acl stream流。
* @return aclnnStatus: 返回状态码。
*/
ACLNN_API aclnnStatus aclnnInplaceBitwiseAndScalar(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor,
aclrtStream stream);
#ifdef __cplusplus
}
#endif
#endif
