mathjs/src/function/bitwise/bitOr.js

'use strict'

import { bitOr as bigBitOr } from '../../utils/bignumber/bitwise'
import { isInteger } from '../../utils/number'
import { factory } from '../../utils/factory'
import { createAlgorithm14 } from '../../type/matrix/utils/algorithm14'
import { createAlgorithm13 } from '../../type/matrix/utils/algorithm13'
import { createAlgorithm10 } from '../../type/matrix/utils/algorithm10'
import { createAlgorithm04 } from '../../type/matrix/utils/algorithm04'
import { createAlgorithm01 } from '../../type/matrix/utils/algorithm01'
import { latexOperators } from '../../utils/latex'

const name = 'bitOr'
const dependencies = [
  'typed',
  'matrix',
  'equalScalar',
  'type.DenseMatrix'
]

export const createBitOr = factory(name, dependencies, ({ typed, matrix, equalScalar, type: { DenseMatrix } }) => {
  const algorithm01 = createAlgorithm01({ typed })
  const algorithm04 = createAlgorithm04({ typed, equalScalar })
  const algorithm10 = createAlgorithm10({ typed, type: { DenseMatrix } })
  const algorithm13 = createAlgorithm13({ typed })
  const algorithm14 = createAlgorithm14({ typed })

  /**
   * Bitwise OR two values, `x | y`.
   * For matrices, the function is evaluated element wise.
   * For units, the function is evaluated on the lowest print base.
   *
   * Syntax:
   *
   *    math.bitOr(x, y)
   *
   * Examples:
   *
   *    math.bitOr(1, 2)               // returns number 3
   *
   *    math.bitOr([1, 2, 3], 4)       // returns Array [5, 6, 7]
   *
   * See also:
   *
   *    bitAnd, bitNot, bitXor, leftShift, rightArithShift, rightLogShift
   *
   * @param  {number | BigNumber | Array | Matrix} x First value to or
   * @param  {number | BigNumber | Array | Matrix} y Second value to or
   * @return {number | BigNumber | Array | Matrix} OR of `x` and `y`
   */
  const bitOr = typed(name, {

    'number, number': function (x, y) {
      if (!isInteger(x) || !isInteger(y)) {
        throw new Error('Integers expected in function bitOr')
      }

      return x | y
    },

    'BigNumber, BigNumber': bigBitOr,

    'SparseMatrix, SparseMatrix': function (x, y) {
      return algorithm04(x, y, bitOr)
    },

    'SparseMatrix, DenseMatrix': function (x, y) {
      return algorithm01(y, x, bitOr, true)
    },

    'DenseMatrix, SparseMatrix': function (x, y) {
      return algorithm01(x, y, bitOr, false)
    },

    'DenseMatrix, DenseMatrix': function (x, y) {
      return algorithm13(x, y, bitOr)
    },

    'Array, Array': function (x, y) {
      // use matrix implementation
      return bitOr(matrix(x), matrix(y)).valueOf()
    },

    'Array, Matrix': function (x, y) {
      // use matrix implementation
      return bitOr(matrix(x), y)
    },

    'Matrix, Array': function (x, y) {
      // use matrix implementation
      return bitOr(x, matrix(y))
    },

    'SparseMatrix, any': function (x, y) {
      return algorithm10(x, y, bitOr, false)
    },

    'DenseMatrix, any': function (x, y) {
      return algorithm14(x, y, bitOr, false)
    },

    'any, SparseMatrix': function (x, y) {
      return algorithm10(y, x, bitOr, true)
    },

    'any, DenseMatrix': function (x, y) {
      return algorithm14(y, x, bitOr, true)
    },

    'Array, any': function (x, y) {
      // use matrix implementation
      return algorithm14(matrix(x), y, bitOr, false).valueOf()
    },

    'any, Array': function (x, y) {
      // use matrix implementation
      return algorithm14(matrix(y), x, bitOr, true).valueOf()
    }
  })

  bitOr.toTex = {
    2: `\\left(\${args[0]}${latexOperators['bitOr']}\${args[1]}\\right)`
  }

  return bitOr
})