mosekcomodel 0.5.0

Library for Conic Optimization Modeling with Mosek
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167


use crate::*;
use crate::domain::{LinearRangeDomain, VectorDomain, VectorDomainTrait};
use crate::model::{BaseModelTrait, PSDModelTrait, VectorConeModelTrait};
use crate::utils::{iter::IndexIteratorExt, ShapeToStridesEx};



/// A Constraint object is a wrapper around an array of constraint
/// indexes and a shape. Note that constraint objects are never sparse.
#[derive(Clone)]
pub struct Constraint<const N : usize> {
    pub(crate) idxs  : Vec<usize>,
    pub(crate) shape : [usize; N]
}

impl<const N : usize> Constraint<N> {
    pub fn new(idxs : Vec<usize>, shape : &[usize;N]) -> Constraint<N> {
        if idxs.len() != shape.iter().product() { panic!("Mismatching index length and shape size"); }
        Constraint{
            idxs,
            shape : *shape,
        }
    }

    pub fn index<I>(&self, idx : I) -> I::Output where I : ModelItemIndex<Self> {
        idx.index(self)
    }
    pub fn reshape<const M : usize>(self, shape : &[usize; M]) -> Constraint<M> {
        if shape.iter().product::<usize>() != self.shape.iter().product::<usize>() {
            panic!("Mismatching shapes");
        }
        Constraint{
            idxs : self.idxs,
            shape : *shape
        }
    }

    pub fn indexes<'a>(&'a self) -> &'a[usize] {
        self.idxs.as_slice()
    }
    // TODO implement more stacking and reshaping functions here, similar to Variable
}

//======================================================
// Domain use
//======================================================

/// Represents something that can be used as a domain for a constraint.
pub trait ConstraintDomain<const N : usize,M> 
{
    type Result;
    fn add_constraint(self, m : & mut M, name : Option<&str>, shape : &[usize], ptr : &[usize], subj : &[usize], cof : &[f64]) -> Result<Self::Result,String>;
}

impl<const N : usize,M> ConstraintDomain<N,M> for LinearDomain<N> where M : BaseModelTrait
{
    type Result = Constraint<N>;

    fn add_constraint(self, m : & mut M, name : Option<&str>, shape : &[usize], ptr : &[usize], subj : &[usize], cof : &[f64]) -> Result<Self::Result,String> {
        m.linear_constraint(name,self,shape,ptr,subj,cof)
    }
}

impl<const N : usize,M> ConstraintDomain<N,M> for LinearRangeDomain<N> where M : BaseModelTrait 
{
    type Result = (Constraint<N>,Constraint<N>);
    fn add_constraint(self, m : & mut M, name : Option<&str>, shape : &[usize], ptr : &[usize], subj : &[usize], cof : &[f64]) -> Result<Self::Result,String> {
        m.ranged_constraint(name,self,shape,ptr,subj,cof)
    }
}

impl<const N : usize,M,D> ConstraintDomain<N,M> for VectorDomain<N,D> where D : VectorDomainTrait, M : VectorConeModelTrait<D> 
{
    type Result = Constraint<N>;
    /// Add a constraint with expression expected to be on the top of the rs stack.
    fn add_constraint(self, m : & mut M, name : Option<&str>, shape : &[usize], ptr : &[usize], subj : &[usize], cof : &[f64]) -> Result<Self::Result,String> {
        m.conic_constraint(name,self,shape,ptr,subj,cof)
    }
}

impl<const N : usize,M> ConstraintDomain<N,M> for PSDDomain<N> where M : PSDModelTrait
{
    type Result = Constraint<N>;
    fn add_constraint(self, m : & mut M, name : Option<&str>, shape : &[usize], ptr : &[usize], subj : &[usize], cof : &[f64]) -> Result<Self::Result,String> {
        m.psd_constraint(name,self,shape,ptr,subj,cof)
    }
}



















impl ModelItemIndex<Constraint<1>> for usize {
    type Output = Constraint<0>;
    fn index(self, v : &Constraint<1>) -> Constraint<0> {
        if v.shape.len() != 1 { panic!("Cannot index into multi-dimensional variable"); }
        Constraint{
            idxs     : vec![v.idxs[self]],
            shape    : []
        }
    }
}

impl<const N : usize> ModelItemIndex<Constraint<N>> for [usize; N] {
    type Output = Constraint<0>;
    fn index(self, v : &Constraint<N>) -> Constraint<0> {
        let index = v.shape.iter().zip(self.iter()).fold(0,|v,(&d,&i)| v*d+i);
        Constraint{
            idxs     : vec![v.idxs[index]],
            shape    : []
        }
    }
}

impl ModelItemIndex<Constraint<1>> for std::ops::Range<usize> {
    type Output = Constraint<1>;
    fn index(self, v : &Constraint<1>) -> Constraint<1> {
        let n = self.len();
        Constraint{
            idxs     : v.idxs[self].to_vec(),
            shape    : [n]
        }
    }
}

impl<const N : usize> ModelItemIndex<Constraint<N>> for [std::ops::Range<usize>; N] {
    type Output = Constraint<N>;
    fn index(self, v : &Constraint<N>) -> Constraint<N> {
        if !self.iter().zip(v.shape.iter()).any(|(r,&d)| r.start > r.end || r.end <= d ) { panic!("The range is out of bounds in the the shape: {:?} in {:?}",self,v.shape) }

        let mut rshape = [0usize;N]; rshape.iter_mut().zip(self.iter()).for_each(|(rs,ra)| *rs = ra.end-ra.start);
        let strides = v.shape.to_strides();

        fn addvec<const N : usize>(lhs : &[usize;N], rhs : &[usize;N]) -> [usize;N] {
            let mut r = [0usize;N]; 
            r.iter_mut().zip(lhs.iter().zip(rhs.iter())).for_each(|(d,(&s0,&s1))| *d = s0+s1 );
            r
        }

        let mut offset = [0usize; N]; offset.iter_mut().zip(self.iter()).for_each(|(o,i)| *o = i.start);
        let ridxs : Vec<usize> = 
            rshape.index_iterator()
                .map(|index| strides.to_linear(&addvec(&index,&offset)))
                .map(|i| v.idxs[i] /*TODO: unsafe get*/)
                .collect();

        Constraint{idxs     : ridxs,
                 shape    : rshape}
    }
}