Current section

Files

Jump to
xberg lib xberg formula.ex
Raw

lib/xberg/formula.ex

# This file is auto-generated by alef — DO NOT EDIT.
# alef:hash:61b2c8938c132132f6ac987a5658fed582bea2f8248dbe1d25aa618e0ec0b375
# To regenerate: alef generate
# To verify freshness: alef verify --exit-code
defmodule Xberg.Formula do
@moduledoc """
A mathematical formula detected and recognized in a document.
Populated by the layout-guided formula pipeline: regions classified as
`LayoutClass::Formula` are routed to the formula OCR task, which returns the
LaTeX source for the region. The field is always present on
[`ExtractedDocument`](super::extraction::ExtractedDocument) but only populated
when the `layout-detection` feature is active and the document contains
formula regions.
"""
@typedoc "A mathematical formula detected and recognized in a document."
@type t :: %__MODULE__{
latex: String.t() | nil,
bbox: Xberg.BoundingBox.t(),
page: non_neg_integer()
}
defstruct latex: nil,
bbox: nil,
page: 0
end