amplrs 0.1.1

Safe Rust API for AMPL optimization modeling system
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

use crate::ffi;
use crate::suffix::Numericsuffix;
use crate::suffix::Stringsuffix;

use libc::c_char;
use std::ffi::{CStr, CString, c_int};
use std::ptr;

pub struct Objective {
  pub(crate) raw: *mut ffi::AMPL,
  pub(crate) name: String,
}

impl Objective {
  pub fn print(&self) {
    println!("Objective: {}", self.name);
  }

  pub fn indexarity(&self) -> usize {
    let name = CString::new(&*self.name).unwrap();
    let mut indexarity: usize = 0;
    unsafe { ffi::AMPL_EntityGetIndexarity(self.raw, name.as_ptr(), &mut indexarity as *mut usize) };
    indexarity
  }

  pub fn num_instances(&self) -> usize {
    let name = CString::new(&*self.name).unwrap();
    let mut num_instances: usize = 0;
    unsafe { ffi::AMPL_EntityGetNumInstances(self.raw, name.as_ptr(), &mut num_instances as *mut usize) };
    num_instances
  }

  pub fn declaration(&mut self) -> String {
    let name = CString::new(&*self.name).unwrap();
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_EntityGetDeclaration(self.raw, name.as_ptr(), &mut value_ptr);
      if value_ptr.is_null() {
        return String::new();
      }
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str
    }
  }

  pub fn drop(&self) {
    let name = CString::new(&*self.name).unwrap();
    unsafe { ffi::AMPL_EntityDrop(self.raw, name.as_ptr()) };
  }

  pub fn restore(&self) {
    let name = CString::new(&*self.name).unwrap();
    unsafe { ffi::AMPL_EntityRestore(self.raw, name.as_ptr()) };
  }

  pub fn value(&self) -> f64 {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Numericsuffix::from(Numericsuffix::Value);
    let mut value: f64 = 0.0;
    unsafe { ffi::AMPL_InstanceGetDoubleSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value as *mut f64) };
    value
  }

  pub fn astatus(&self) -> String {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Stringsuffix::from(Stringsuffix::Astatus);
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_InstanceGetStringSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value_ptr);
      if value_ptr.is_null() {
        return String::new();
      }
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str
    }
  }

  pub fn sstatus(&self) -> String {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Stringsuffix::from(Stringsuffix::Sstatus);
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_InstanceGetStringSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value_ptr);
      if value_ptr.is_null() {
        return String::new();
      }
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str
    }
  }

  pub fn exitcode(&self) -> i32 {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Numericsuffix::from(Numericsuffix::Exitcode);
    let mut value: c_int = 0;
    unsafe {
      ffi::AMPL_InstanceGetIntSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value);
    }
    value
  }

  pub fn message(&self) -> String {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Stringsuffix::from(Stringsuffix::Message);
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_InstanceGetStringSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value_ptr);
      if value_ptr.is_null() {
        return String::new();
      }
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str
    }
  }

  pub fn result(&self) -> String {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Stringsuffix::from(Stringsuffix::Result);
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_InstanceGetStringSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value_ptr);
      if value_ptr.is_null() {
        return String::new();
      }
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str
    }
  }

  pub fn is_minimization(&self) -> bool {
    let name = CString::new(&*self.name).unwrap();
    let suffix_c = Stringsuffix::from(Stringsuffix::Sense);
    let mut value_ptr: *mut c_char = ptr::null_mut();
    unsafe {
      ffi::AMPL_InstanceGetStringSuffix(self.raw, name.as_ptr(), std::ptr::null_mut(), suffix_c.into(), &mut value_ptr);
      //if value_ptr.is_null() {
      //  return String::new();
      //}
      let value_str = CStr::from_ptr(value_ptr).to_str().unwrap().to_string();
      ffi::AMPL_StringFree(&mut value_ptr);
      value_str == "minimize"
    }
  }
}