stdlib_array.f90 Source File

! SPDX-Identifier: MIT

!> Module for index manipulation and general array handling
!>
!> The specification of this module is available [here](../page/specs/stdlib_array.html).
module stdlib_array
  implicit none
  private

  public :: trueloc, falseloc

contains

  !> Version: experimental
  !>
  !> Return the positions of the true elements in array.
  !> [Specification](../page/specs/stdlib_array.html#trueloc)
  pure function trueloc(array, lbound) result(loc)
    !> Mask of logicals
    logical, intent(in) :: array(:)
    !> Lower bound of array to index
    integer, intent(in), optional :: lbound
    !> Locations of true elements
    integer :: loc(count(array))

    call logicalloc(loc, array, .true., lbound)
  end function trueloc

  !> Version: experimental
  !>
  !> Return the positions of the false elements in array.
  !> [Specification](../page/specs/stdlib_array.html#falseloc)
  pure function falseloc(array, lbound) result(loc)
    !> Mask of logicals
    logical, intent(in) :: array(:)
    !> Lower bound of array to index
    integer, intent(in), optional :: lbound
    !> Locations of false elements
    integer :: loc(count(.not.array))

    call logicalloc(loc, array, .false., lbound)
  end function falseloc

  !> Return the positions of the truthy elements in array
  pure subroutine logicalloc(loc, array, truth, lbound)
    !> Locations of truthy elements
    integer, intent(out) :: loc(:)
    !> Mask of logicals
    logical, intent(in) :: array(:)
    !> Truthy value
    logical, intent(in) :: truth
    !> Lower bound of array to index
    integer, intent(in), optional :: lbound
    integer :: i, pos, offset

    offset = 0
    if (present(lbound)) offset = lbound - 1

    i = 0
    do pos = 1, size(array)
      if (array(pos).eqv.truth) then
        i = i + 1
        loc(i) = pos + offset
      end if
    end do
  end subroutine logicalloc

end module stdlib_array