Skip to main content

BestDoseProblem

Struct BestDoseProblem 

Source
pub struct BestDoseProblem<E: Equation> { /* private fields */ }
Expand description

A dose-optimization problem over a parameter distribution.

A BestDoseProblem pairs a model with a distribution over its parameters — the support points (Theta) and their probability Weights. The distribution is supplied by the caller: it may be a population fit, or a patient-specific posterior computed with NCNPAG/NPMAP from past data.

Call optimize to solve for the doses that best hit a target profile.

§Example

let problem = BestDoseProblem::new(eq, theta, weights)?;
let result = problem.optimize(
    target,
    Target::Concentration,
    DoseRange::new(0.0, 300.0),
    0.5,
    BestDoseOptions::default(),
)?;
let optimal_subject = result.subject();
let cost = result.cost();

Implementations§

Source§

impl<E: Equation> BestDoseProblem<E>

Source

pub fn new(eq: E, theta: Theta, weights: Weights) -> Result<Self>

Creates a dose-optimization problem from a model and a parameter distribution.

Returns an error if the number of weights does not match the number of support points in theta.

Source

pub fn optimize( &self, target: Subject, target_type: Target, dose_range: DoseRange, bias: f64, options: BestDoseOptions, ) -> Result<BestDoseResult>

Solves for the optimal doses that hit target.

Doses in the target subject with amount 0.0 are optimized; non-zero doses stay fixed. bias (λ ∈ [0, 1]) trades off minimizing the expected squared error over the distribution (λ = 0) against minimizing the error of the weighted-mean prediction (λ = 1).

Returns the optimal dosing Subject and its cost. Predictions can be generated afterwards by simulating the returned subject.

Source

pub fn theta(&self) -> &Theta

The support points of the distribution.

Source

pub fn weights(&self) -> &Weights

The probability weights of the distribution.

Trait Implementations§

Source§

impl<E: Clone + Equation> Clone for BestDoseProblem<E>

Source§

fn clone(&self) -> BestDoseProblem<E>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<E> Freeze for BestDoseProblem<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for BestDoseProblem<E>
where E: RefUnwindSafe,

§

impl<E> Send for BestDoseProblem<E>
where E: Send,

§

impl<E> Sync for BestDoseProblem<E>

§

impl<E> Unpin for BestDoseProblem<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for BestDoseProblem<E>
where E: UnsafeUnpin,

§

impl<E> UnwindSafe for BestDoseProblem<E>
where E: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SendAlias for T

§

impl<T> SyncAlias for T