ptfkit.chakraborty2011

def calc_ptf_chakraborty2011_eq1(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from clay and silt.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 1

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.820, 0.709, 0.698, and 0.489 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.351, 5.051, 3.837, and 4.488 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq1,
        clay,
        silt,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)

def calc_ptf_chakraborty2011_eq2(
    *,
    sand: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from sand and bulk density.

    Arguments:
        sand: Sand content by mass. (%)
        bulk_density: Dry soil bulk density. (Mg/m^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 2

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.812, 0.726, 0.721, and 0.519 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.454, 4.875, 3.691, and 4.352 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq2,
        sand,
        bulk_density,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)

def calc_ptf_chakraborty2011_eq3(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from clay, silt, and bulk density.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        bulk_density: Dry soil bulk density. (Mg/m^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 3

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.830, 0.711, 0.701, and 0.490 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.253, 5.059, 3.843, and 4.509 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq3,
        clay,
        silt,
        bulk_density,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)

def calc_ptf_chakraborty2011_eq4(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    sand: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from clay, silt, and sand.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        sand: Sand content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 4

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.844, 0.737, 0.734, and 0.524 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.078, 4.820, 3.618, and 4.365 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq4,
        clay,
        silt,
        sand,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)

def calc_ptf_chakraborty2011_eq5(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    sand: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from clay, silt, sand, and bulk density.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        sand: Sand content by mass. (%)
        bulk_density: Dry soil bulk density. (Mg/m^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 5

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.847, 0.737, 0.734, and 0.526 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.045, 4.855, 3.637, and 4.370 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq5,
        clay,
        silt,
        sand,
        bulk_density,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)

def calc_ptf_chakraborty2011_eq6(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    sand: float | ArrayLike,
    organic_carbon: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Chakraborty2011PTFResult[NDArray[floating]] | None = None,
) -> Chakraborty2011PTFResult[floating] | Chakraborty2011PTFResult[NDArray[floating]]:
    r"""Estimate four gravimetric water contents from texture, organic carbon, and bulk density.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        sand: Sand content by mass. (%)
        organic_carbon: Soil organic carbon content by mass. (%)
        bulk_density: Dry soil bulk density. (Mg/m^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Chakraborty2011PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Four point estimates from regression equation set 6

    Notes:
        Prediction target: Gravimetric water content at -33, -100, -500, and -1500 kPa.
        Table 3 reports R-squared values of 0.849, 0.750, 0.736, and 0.529 at -33, -100, -500, and
            -1500 kPa, respectively.
        Table 3 reports SEE values of 4.060, 5.682, 3.645, and 4.369 percentage points at the four
            respective potentials.

    Warning:
        Use outside the source Indian-soil dataset requires independent validation.

    """
    values = _call(
        _calc_ptf_chakraborty2011_eq6,
        clay,
        silt,
        sand,
        organic_carbon,
        bulk_density,
        out=out,
    )

    return Chakraborty2011PTFResult(*values)