Scippy

SCIP

Solving Constraint Integer Programs

type_tpi.h File Reference

Detailed Description

the type definitions for the task processing interface

Author
Leona Gottwald
Stephen J. Maher
Marc Pfetsch

Definition in file type_tpi.h.

Go to the source code of this file.

Typedefs

typedef enum SCIP_Submitstatus SCIP_SUBMITSTATUS
 
typedef enum SCIP_Jobstatus SCIP_JOBSTATUS
 
typedef struct SCIP_Job SCIP_JOB
 
typedef struct SCIP_Lock SCIP_LOCK
 
typedef struct SCIP_Condition SCIP_CONDITION
 

Enumerations

enum  SCIP_Submitstatus {
  SCIP_SUBMIT_QUEUEFULL = -3 ,
  SCIP_SUBMIT_QUEUECLOSED = -2 ,
  SCIP_SUBMIT_SHUTDOWN = -1 ,
  SCIP_SUBMIT_SUCCESS = 0
}
 
enum  SCIP_Jobstatus {
  SCIP_JOB_DOESNOTEXIST = -1 ,
  SCIP_JOB_INQUEUE = 0 ,
  SCIP_JOB_ISRUNNING = 1 ,
  SCIP_JOB_ISFINISHED = 2
}
 

Typedef Documentation

◆ SCIP_SUBMITSTATUS

Definition at line 50 of file type_tpi.h.

◆ SCIP_JOBSTATUS

Definition at line 65 of file type_tpi.h.

◆ SCIP_JOB

typedef struct SCIP_Job SCIP_JOB

a job to be submitted to a separate thread

Definition at line 67 of file type_tpi.h.

◆ SCIP_LOCK

typedef struct SCIP_Lock SCIP_LOCK

TPI type dependent lock

Definition at line 70 of file type_tpi.h.

◆ SCIP_CONDITION

TPI type dependent condition

Definition at line 71 of file type_tpi.h.

Enumeration Type Documentation

◆ SCIP_Submitstatus

The status after submitting a job

Enumerator
SCIP_SUBMIT_QUEUEFULL 
SCIP_SUBMIT_QUEUECLOSED 
SCIP_SUBMIT_SHUTDOWN 
SCIP_SUBMIT_SUCCESS 

Definition at line 43 of file type_tpi.h.

◆ SCIP_Jobstatus

The job status

There is more than one job per job id. So the job status will return either SCIP_JOB_DOESNOTEXIST or the lowest level of execution. For example, if there is a job running and a job in the queue, then the return will be SCIP_JOB_INQUEUE.

Enumerator
SCIP_JOB_DOESNOTEXIST 
SCIP_JOB_INQUEUE 
SCIP_JOB_ISRUNNING 
SCIP_JOB_ISFINISHED 

Definition at line 58 of file type_tpi.h.