primitive-object.ts

/**
 * Copyright 2023-present DreamNum Inc.
 *
 * 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:https://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 { isRealNum } from '@univerjs/core';
import { reverseCompareOperator } from '../../basics/calculate';
import { BooleanValue, ConcatenateType } from '../../basics/common';
import { ERROR_TYPE_SET, ErrorType } from '../../basics/error-type';
import { compareToken, operatorToken } from '../../basics/token';
import { compareWithWildcard, isWildcard } from '../utils/compare';
import { ceil, divide, equals, floor, greaterThan, greaterThanOrEquals, lessThan, lessThanOrEquals, minus, mod, multiply, plus, pow, round, sqrt } from '../utils/math-kit';
import { FormulaAstLRU } from '../../basics/cache-lru';
import { comparePatternPriority } from '../utils/numfmt-kit';
import { BaseValueObject, ErrorValueObject } from './base-value-object';

export type PrimitiveValueType = string | boolean | number | null;

export class NullValueObject extends BaseValueObject {
    private static _instance: NullValueObject;

    static create() {
        this._instance = this._instance || new NullValueObject(0);
        return this._instance;
    }

    override isNull(): boolean {
        return true;
    }

    override plus(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).plus(valueObject);
    }

    override minus(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).minus(valueObject);
    }

    override multiply(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).multiply(valueObject);
    }

    override divided(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).divided(valueObject);
    }

    override mod(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).mod(valueObject);
    }

    override compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject {
        if (valueObject.isString()) {
            return StringValueObject.create('').compare(valueObject, operator);
        }
        if (valueObject.isBoolean()) {
            return BooleanValueObject.create(false).compare(valueObject, operator);
        }
        return NumberValueObject.create(0).compare(valueObject, operator);
    }

    override concatenateFront(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateBack(StringValueObject.create(''));
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.FRONT));
    }

    override concatenateBack(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateFront(StringValueObject.create(''));
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.BACK));
    }

    override plusBy(value: string | number | boolean): BaseValueObject {
        return NumberValueObject.create(0).plusBy(value);
    }

    override minusBy(value: string | number | boolean): BaseValueObject {
        return NumberValueObject.create(0).minusBy(value);
    }

    override multiplyBy(value: string | number | boolean): BaseValueObject {
        return NumberValueObject.create(0).multiplyBy(value);
    }

    override dividedBy(value: string | number | boolean): BaseValueObject {
        return NumberValueObject.create(0).dividedBy(value);
    }

    override compareBy(value: string | number | boolean, operator: compareToken): BaseValueObject {
        if (typeof value === 'string') {
            return StringValueObject.create('').compareBy(value, operator);
        }
        if (typeof value === 'boolean') {
            return BooleanValueObject.create(false).compareBy(value, operator);
        }
        return NumberValueObject.create(0).compareBy(value, operator);
    }

    override pow(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).pow(valueObject);
    }

    override sqrt(): BaseValueObject {
        return NumberValueObject.create(0).sqrt();
    }

    override cbrt(): BaseValueObject {
        return NumberValueObject.create(0).cbrt();
    }

    override cos(): BaseValueObject {
        return NumberValueObject.create(0).cos();
    }

    override acos(): BaseValueObject {
        return NumberValueObject.create(0).acos();
    }

    override acosh(): BaseValueObject {
        return NumberValueObject.create(0).acosh();
    }

    override sin(): BaseValueObject {
        return NumberValueObject.create(0).sin();
    }

    override asin(): BaseValueObject {
        return NumberValueObject.create(0).asin();
    }

    override asinh(): BaseValueObject {
        return NumberValueObject.create(0).asinh();
    }

    override tan(): BaseValueObject {
        return NumberValueObject.create(0).tan();
    }

    override tanh(): BaseValueObject {
        return NumberValueObject.create(0).tanh();
    }

    override atan(): BaseValueObject {
        return NumberValueObject.create(0).atan();
    }

    override atan2(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).atan2(valueObject);
    }

    override atanh(): BaseValueObject {
        return NumberValueObject.create(0).atanh();
    }

    override log(): BaseValueObject {
        return ErrorValueObject.create(ErrorType.NUM);
    }

    override log10(): BaseValueObject {
        return ErrorValueObject.create(ErrorType.NUM);
    }

    override exp(): BaseValueObject {
        return NumberValueObject.create(0).exp();
    }

    override abs(): BaseValueObject {
        return NumberValueObject.create(0).abs();
    }

    override round(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).round(valueObject);
    }

    override floor(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).floor(valueObject);
    }

    override ceil(valueObject: BaseValueObject): BaseValueObject {
        return NumberValueObject.create(0).ceil(valueObject);
    }

    override convertToNumberObjectValue() {
        return NumberValueObject.create(0);
    }

    override convertToBooleanObjectValue() {
        return BooleanValueObject.create(false);
    }
}

export class BooleanValueObject extends BaseValueObject {
    private _value: boolean = false;

    private static _instanceTrue: BooleanValueObject;

    private static _instanceFalse: BooleanValueObject;

    static create(value: boolean) {
        if (value) {
            this._instanceTrue = this._instanceTrue || new BooleanValueObject(true);
            return this._instanceTrue;
        }
        this._instanceFalse = this._instanceFalse || new BooleanValueObject(false);
        return this._instanceFalse;
    }

    constructor(rawValue: boolean) {
        super(rawValue);

        this._value = rawValue;
    }

    override getValue() {
        return this._value;
    }

    override isBoolean() {
        return true;
    }

    override getNegative(): BaseValueObject {
        const currentValue = this.getValue();
        let result = 0;
        if (currentValue) {
            result = 1;
        }
        return NumberValueObject.create(-result);
    }

    override getReciprocal(): BaseValueObject {
        const currentValue = this.getValue();
        if (currentValue) {
            return NumberValueObject.create(1);
        }
        return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
    }

    override plus(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().plus(valueObject);
    }

    override minus(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().minus(valueObject);
    }

    override multiply(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().multiply(valueObject);
    }

    override divided(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().divided(valueObject);
    }

    override mod(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().mod(valueObject);
    }

    override compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.compare(this, reverseCompareOperator(operator));
        }

        return this.compareBy(valueObject.getValue(), operator);
    }

    override compareBy(value: string | number | boolean, operator: compareToken): BaseValueObject {
        let result = false;
        // FALSE > 0 and FALSE > "Univer" get TRUE
        if (typeof value === 'string' || typeof value === 'number') {
            result = this._compareString(operator);
        } else if (typeof value === 'boolean') {
            const booleanNumber = NumberValueObject.create(value ? 1 : 0);
            return this._convertTonNumber().compare(booleanNumber, operator);
        }

        return BooleanValueObject.create(result);
    }

    private _compareString(operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
            case compareToken.GREATER_THAN:
            case compareToken.GREATER_THAN_OR_EQUAL:
                return true;
            case compareToken.LESS_THAN:
            case compareToken.LESS_THAN_OR_EQUAL:
            case compareToken.NOT_EQUAL:
                return false;
        }
    }

    override concatenateFront(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().concatenateFront(valueObject);
    }

    override concatenateBack(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().concatenateBack(valueObject);
    }

    private _convertTonNumber() {
        const currentValue = this.getValue();
        let result = 0;
        if (currentValue) {
            result = 1;
        }
        return NumberValueObject.create(result);
    }

    override pow(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().pow(valueObject);
    }

    override sqrt(): BaseValueObject {
        return this._convertTonNumber().sqrt();
    }

    override cbrt(): BaseValueObject {
        return this._convertTonNumber().cbrt();
    }

    override cos(): BaseValueObject {
        return this._convertTonNumber().cos();
    }

    override acos(): BaseValueObject {
        return this._convertTonNumber().acos();
    }

    override acosh(): BaseValueObject {
        return this._convertTonNumber().acosh();
    }

    override sin(): BaseValueObject {
        return this._convertTonNumber().sin();
    }

    override asin(): BaseValueObject {
        return this._convertTonNumber().asin();
    }

    override asinh(): BaseValueObject {
        return this._convertTonNumber().asinh();
    }

    override tan(): BaseValueObject {
        return this._convertTonNumber().tan();
    }

    override tanh(): BaseValueObject {
        return this._convertTonNumber().tanh();
    }

    override atan(): BaseValueObject {
        return this._convertTonNumber().atan();
    }

    override atan2(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().atan2(valueObject);
    }

    override atanh(): BaseValueObject {
        return this._convertTonNumber().atanh();
    }

    override log(): BaseValueObject {
        return this._convertTonNumber().log();
    }

    override log10(): BaseValueObject {
        return this._convertTonNumber().log10();
    }

    override exp(): BaseValueObject {
        return this._convertTonNumber().exp();
    }

    override abs(): BaseValueObject {
        return this._convertTonNumber().abs();
    }

    override round(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().round(valueObject);
    }

    override floor(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().floor(valueObject);
    }

    override ceil(valueObject: BaseValueObject): BaseValueObject {
        return this._convertTonNumber().ceil(valueObject);
    }

    override convertToNumberObjectValue() {
        return createNumberValueObjectByRawValue(this.getValue());
    }

    override convertToBooleanObjectValue() {
        return this;
    }
}

const NUMBER_CACHE_LRU_COUNT = 200000;

export const NumberValueObjectCache = new FormulaAstLRU<NumberValueObject>(NUMBER_CACHE_LRU_COUNT);

export class NumberValueObject extends BaseValueObject {
    private _value: number = 0;

    static create(value: number) {
        const key = `${value}`;
        const cached = NumberValueObjectCache.get(key);
        if (cached) {
            // The NumberValueObject may be cached with a number format, but the next time the cache is retrieved, the number format is not required.
            cached.setPattern('');
            return cached;
        }
        const instance = new NumberValueObject(value);
        NumberValueObjectCache.set(key, instance);
        return instance;
    }

    constructor(rawValue: number) {
        super(rawValue);

        this._value = Number(rawValue);
    }

    override getValue() {
        return this._value;
    }

    override setValue(value: number) {
        this._value = value;
    }

    override isNumber() {
        return true;
    }

    override getNegative(): BaseValueObject {
        return NumberValueObject.create(0).minus(this);
    }

    override getReciprocal(): BaseValueObject {
        return NumberValueObject.create(1).divided(this);
    }

    override plus(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.plus(this);
        }
        const object = this.plusBy(valueObject.getValue());

        // = 1 + #NAME? gets #NAME?, = 1 + #VALUE! gets #VALUE!
        if (object.isError()) {
            return object;
        }

        // Set number format
        object.setPattern(comparePatternPriority(this.getPattern(), valueObject.getPattern(), operatorToken.PLUS));

        return object;
    }

    equalZero() {
        return this._value === 0;
    }

    override minus(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            const o = valueObject.getNegative();
            if (o.isError()) {
                return o;
            }
            return (o as BaseValueObject).plus(this);
        }
        const object = this.minusBy(valueObject.getValue());

        // = 1 - #NAME? gets #NAME?, = 1 - #VALUE! gets #VALUE!
        if (object.isError()) {
            return object;
        }

        // Set number format
        object.setPattern(comparePatternPriority(this.getPattern(), valueObject.getPattern(), operatorToken.MINUS));

        return object;
    }

    override multiply(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.multiply(this);
        }
        const object = this.multiplyBy(valueObject.getValue());

        // = 1 * #NAME? gets #NAME?, = 1 * #VALUE! gets #VALUE!
        if (object.isError()) {
            return object;
        }

        // Set number format
        object.setPattern(comparePatternPriority(this.getPattern(), valueObject.getPattern(), operatorToken.MULTIPLY));

        return object;
    }

    override divided(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            const o = valueObject.getReciprocal();
            if (o.isError()) {
                return o;
            }
            return (o as BaseValueObject).multiply(this);
        }
        const object = this.dividedBy(valueObject.getValue());

        // = 1 / #NAME? gets #NAME?, = 1 / #VALUE! gets #VALUE!
        if (object.isError()) {
            return object;
        }

        // Set number format
        object.setPattern(comparePatternPriority(this.getPattern(), valueObject.getPattern(), operatorToken.DIVIDED));

        return object;
    }

    override mod(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.modInverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (valueObject.isNull()) {
            return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
        }

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (value === 0) {
                return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
            }

            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            // Parameters in MOD caused an out of range error. Namely, the error occurs when the following is true: (divisor * 1125900000000) is less than or equal to dividend.
            if (Math.abs(value) * 1125900000000 <= Math.abs(currentValue)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = mod(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            const booleanValue = value ? 1 : 0;

            if (booleanValue === 0) {
                return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
            }

            return NumberValueObject.create(mod(currentValue, booleanValue));
        }

        return this;
    }

    override concatenateFront(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateBack(this);
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.FRONT));
    }

    override concatenateBack(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateFront(this);
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.BACK));
    }

    override compare(valueObject: BaseValueObject, operator: compareToken): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.compare(this, reverseCompareOperator(operator));
        }
        return this.compareBy(valueObject.getValue(), operator);
    }

    override plusBy(value: string | number | boolean): BaseValueObject {
        const currentValue = this.getValue();
        if (typeof value === 'string') {
            // = 1 + #NAME? gets #NAME?, = 1 + #VALUE! gets #VALUE!
            if (ERROR_TYPE_SET.has(value as ErrorType)) {
                return ErrorValueObject.create(value as ErrorType);
            }
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = plus(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(
                plus(currentValue, value ? 1 : 0)
            );
        }
        return this;
    }

    override minusBy(value: string | number | boolean): BaseValueObject {
        const currentValue = this.getValue();
        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = minus(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(
                minus(currentValue, value ? 1 : 0)
            );
        }
        return this;
    }

    override multiplyBy(value: string | number | boolean): BaseValueObject {
        const currentValue = this.getValue();
        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = multiply(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }
            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(
                multiply(currentValue, value ? 1 : 0)
            );
        }
        return this;
    }

    override dividedBy(value: string | number | boolean): BaseValueObject {
        const currentValue = this.getValue();
        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (value === 0) {
                return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
            }
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = divide(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            if (value === false) {
                return ErrorValueObject.create(ErrorType.DIV_BY_ZERO);
            }
            return NumberValueObject.create(divide(currentValue, 1));
        }
        return this;
    }

    override compareBy(value: string | number | boolean, operator: compareToken): BaseValueObject {
        const currentValue = this.getValue();
        let result = false;

        if (typeof value === 'string') {
            result = this._compareString(operator);
        } else if (typeof value === 'number') {
            result = this._compareNumber(currentValue, value, operator);
        } else if (typeof value === 'boolean') {
            result = this._compareBoolean(operator);
        }

        return BooleanValueObject.create(result);
    }

    private _compareString(operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
            case compareToken.GREATER_THAN:
            case compareToken.GREATER_THAN_OR_EQUAL:
                return false;
            case compareToken.LESS_THAN:
            case compareToken.LESS_THAN_OR_EQUAL:
            case compareToken.NOT_EQUAL:
                return true;
        }
    }

    private _compareNumber(currentValue: number, value: number, operator: compareToken): boolean {
        if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
            return this._compareInfinity(currentValue, value, operator);
        } else {
            return this._compareFiniteNumber(currentValue, value, operator);
        }
    }

    private _compareFiniteNumber(currentValue: number, value: number, operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
                return equals(currentValue, value);
            case compareToken.GREATER_THAN:
                return greaterThan(currentValue, value);
            case compareToken.GREATER_THAN_OR_EQUAL:
                return greaterThanOrEquals(currentValue, value);
            case compareToken.LESS_THAN:
                return lessThan(currentValue, value);
            case compareToken.LESS_THAN_OR_EQUAL:
                return lessThanOrEquals(currentValue, value);
            case compareToken.NOT_EQUAL:
                return !equals(currentValue, value);
        }
    }

    private _compareBoolean(operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
            case compareToken.GREATER_THAN:
            case compareToken.GREATER_THAN_OR_EQUAL:
                return false;
            case compareToken.LESS_THAN:
            case compareToken.LESS_THAN_OR_EQUAL:
            case compareToken.NOT_EQUAL:
                return true;
        }
    }

    override pow(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.powInverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = pow(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(pow(currentValue, value ? 1 : 0));
        }

        return this;
    }

    override sqrt(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = sqrt(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override cbrt(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.cbrt(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override cos(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.cos(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override acos(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.acos(currentValue);

        if (Number.isNaN(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override acosh(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.acosh(currentValue);

        if (Number.isNaN(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override sin(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.sin(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override asin(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.asin(currentValue);

        if (Number.isNaN(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override asinh(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.asinh(currentValue);

        if (Number.isNaN(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override tan(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.tan(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override tanh(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.tanh(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override atan(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.atan(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override atan2(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.atan2Inverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = Math.atan2(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(Math.atan2(currentValue, value ? 1 : 0));
        }

        return this;
    }

    override atanh(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.atanh(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override log(): BaseValueObject {
        const currentValue = this.getValue();

        if (typeof currentValue === 'number' && currentValue <= 0) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.log(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override log10(): BaseValueObject {
        const currentValue = this.getValue();

        if (typeof currentValue === 'number' && currentValue <= 0) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.log10(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override exp(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.exp(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override abs(): BaseValueObject {
        const currentValue = this.getValue();

        if (!Number.isFinite(currentValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        const result = Math.abs(currentValue);

        if (!Number.isFinite(result)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }

        return NumberValueObject.create(result);
    }

    override round(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.roundInverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = round(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(round(currentValue, value ? 1 : 0));
        }

        return this;
    }

    override floor(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.floorInverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = floor(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(floor(currentValue, value ? 1 : 0));
        }

        return this;
    }

    override ceil(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.ceilInverse(this);
        }

        const currentValue = this.getValue();
        const value = valueObject.getValue();

        if (typeof value === 'string') {
            return ErrorValueObject.create(ErrorType.VALUE);
        }
        if (typeof value === 'number') {
            if (!Number.isFinite(currentValue) || !Number.isFinite(value)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            const result = ceil(currentValue, value);

            if (!Number.isFinite(result)) {
                return ErrorValueObject.create(ErrorType.NUM);
            }

            return NumberValueObject.create(result);
        }
        if (typeof value === 'boolean') {
            return NumberValueObject.create(ceil(currentValue, value ? 1 : 0));
        }

        return this;
    }

    override convertToNumberObjectValue() {
        return this;
    }

    override convertToBooleanObjectValue() {
        return createBooleanValueObjectByRawValue(true);
    }

    private _compareInfinity(currentValue: number, value: number, operator: compareToken) {
        let result = false;
        switch (operator) {
            case compareToken.EQUALS:
                result = currentValue === value;
                break;
            case compareToken.GREATER_THAN:
                result = currentValue > value;
                break;
            case compareToken.GREATER_THAN_OR_EQUAL:
                result = currentValue >= value;
                break;
            case compareToken.LESS_THAN:
                result = currentValue < value;
                break;
            case compareToken.LESS_THAN_OR_EQUAL:
                result = currentValue <= value;
                break;
            case compareToken.NOT_EQUAL:
                result = currentValue !== value;
                break;
        }

        return result;
    }
}

const STRING_CACHE_LRU_COUNT = 200000;

export const StringValueObjectCache = new FormulaAstLRU<StringValueObject>(STRING_CACHE_LRU_COUNT);
export class StringValueObject extends BaseValueObject {
    private _value: string;

    static create(value: string) {
        const cached = StringValueObjectCache.get(value);
        if (cached) {
            return cached;
        }
        const instance = new StringValueObject(value);
        StringValueObjectCache.set(value, instance);
        return instance;
    }

    constructor(rawValue: string) {
        super(rawValue);
        this._value = rawValue;
    }

    override getValue() {
        return this._value;
    }

    override isString() {
        return true;
    }

    override concatenateFront(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateBack(this);
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.FRONT));
    }

    override concatenateBack(valueObject: BaseValueObject): BaseValueObject {
        if (valueObject.isArray()) {
            return valueObject.concatenateFront(this);
        }
        return StringValueObject.create(this.concatenate(valueObject.getValue(), ConcatenateType.BACK));
    }

    override compare(valueObject: BaseValueObject, operator: compareToken, isCaseSensitive?: boolean): BaseValueObject {
        if (valueObject.isArray()) {
            // const o = valueObject.getReciprocal();
            // if (o.isError()) {
            //     return o;
            // }
            return valueObject.compare(this, reverseCompareOperator(operator), isCaseSensitive);
        }
        return this.compareBy(valueObject.getValue(), operator, isCaseSensitive);
    }

    override compareBy(value: string | number | boolean, operator: compareToken, isCaseSensitive: boolean = false): BaseValueObject {
        let currentValue = this.getValue();
        let result = false;

        if (typeof value === 'string') {
            // Case sensitivity needs to be considered, most functions are case-insensitive, like VLOOKUP/HLOOKUP/XLOOKUP/MATCH/COUNTIF/COUNTIFS/SUMIF/SUMIFS/SEARCH/FIND(in SUBSTITUTE)
            // A few functions are case-sensitive, like EXACT/FIND/FINDB/REPLACE/REPLACEB/MIDB
            if (!isCaseSensitive) {
                currentValue = currentValue.toLocaleLowerCase();
                value = value.toLocaleLowerCase();
            }

            if (isWildcard(value)) {
                return this._checkWildcard(value, operator);
            }
            result = this._compareString(currentValue, value, operator);
        } else if (typeof value === 'number') {
            result = this._compareNumber(operator);
        } else if (typeof value === 'boolean') {
            result = this._compareBoolean(operator);
        }

        return BooleanValueObject.create(result);
    }

    private _compareString(currentValue: string, value: string, operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
                return currentValue === value;
            case compareToken.GREATER_THAN:
                return currentValue > value;
            case compareToken.GREATER_THAN_OR_EQUAL:
                return currentValue >= value;
            case compareToken.LESS_THAN:
                return currentValue < value;
            case compareToken.LESS_THAN_OR_EQUAL:
                return currentValue <= value;
            case compareToken.NOT_EQUAL:
                return currentValue !== value;
        }
    }

    private _compareNumber(operator: compareToken): boolean {
        switch (operator) {
            case compareToken.NOT_EQUAL:
            case compareToken.GREATER_THAN:
            case compareToken.GREATER_THAN_OR_EQUAL:
                return true;
            case compareToken.EQUALS:
            case compareToken.LESS_THAN:
            case compareToken.LESS_THAN_OR_EQUAL:
                return false;
        }
    }

    private _compareBoolean(operator: compareToken): boolean {
        switch (operator) {
            case compareToken.EQUALS:
            case compareToken.GREATER_THAN:
            case compareToken.GREATER_THAN_OR_EQUAL:
                return false;
            case compareToken.LESS_THAN:
            case compareToken.LESS_THAN_OR_EQUAL:
            case compareToken.NOT_EQUAL:
                return true;
        }
    }

    override convertToNumberObjectValue() {
        return createNumberValueObjectByRawValue(this.getValue());
    }

    override convertToBooleanObjectValue() {
        return BooleanValueObject.create(true);
    }

    private _checkWildcard(value: string, operator: compareToken) {
        const currentValue = this.getValue().toLocaleLowerCase();
        const result = compareWithWildcard(currentValue, value, operator);

        return BooleanValueObject.create(result);
    }
}

export function createBooleanValueObjectByRawValue(rawValue: string | number | boolean) {
    if (typeof rawValue === 'boolean') {
        return BooleanValueObject.create(rawValue);
    }
    let value = false;
    if (typeof rawValue === 'string') {
        const rawValueUpper = rawValue.toLocaleUpperCase();
        if (rawValueUpper === BooleanValue.TRUE) {
            value = true;
        } else if (rawValueUpper === BooleanValue.FALSE) {
            value = false;
        }
    } else {
        if (rawValue === 1) {
            value = true;
        } else {
            value = false;
        }
    }
    return BooleanValueObject.create(value);
}

export function createStringValueObjectByRawValue(rawValue: string | number | boolean) {
    let value = rawValue.toString();

    if (value.charAt(0) === '"' && value.charAt(value.length - 1) === '"') {
        value = value.slice(1, -1);
        value = value.replace(/""/g, '"');
    }

    return StringValueObject.create(value);
}

export function createNumberValueObjectByRawValue(rawValue: string | number | boolean) {
    if (typeof rawValue === 'boolean') {
        let result = 0;
        if (rawValue) {
            result = 1;
        }
        return NumberValueObject.create(result);
    } else if (typeof rawValue === 'number') {
        if (!Number.isFinite(rawValue)) {
            return ErrorValueObject.create(ErrorType.NUM);
        }
        return NumberValueObject.create(rawValue);
    } else if (isRealNum(rawValue)) {
        return NumberValueObject.create(Number(rawValue));
    }
    return ErrorValueObject.create(ErrorType.VALUE);
}