cpp-taskflow/taskflow/core/task.hpp at cpp14 · gicho/cpp-taskflow · GitHub

Repository navigation

History

544 lines (409 loc) · 10.3 KB

Raw

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

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

#pragma once

#include "graph.hpp"

namespace tf {

/**

@class Task

@brief Handle to modify and access a task.

A Task is a wrapper of a node in a dependency graph.

It provides a set of methods for users to access and modify the attributes of

the task node,

preventing direct access to the internal data storage.

class Task {

friend class FlowBuilder;

friend class Taskflow;

friend class TaskView;

public:

/**

@brief constructs an empty task

Task() = default;

/**

@brief constructs the task with the copy of the other task

Task(const Task& other);

/**

@brief replaces the contents with a copy of the other task

Task& operator = (const Task&);

/**

@brief replaces the contents with a null pointer

Task& operator = (std::nullptr_t);

/**

@brief queries the name of the task

const std::string& name() const;

/**

@brief queries the number of successors of the task

size_t num_successors() const;

/**

@brief queries the number of predecessors of the task

size_t num_dependents() const;

/**

@brief assigns a name to the task

@param name a @std_string acceptable string

@return @c *this

Task& name(const std::string& name);

/**

@brief assigns a new callable object to the task

@tparam C callable object type

@param callable a callable object acceptable to @std_function

@return @c *this

template <typename C>

Task& work(C&& callable);

/**

@brief adds precedence links from this to other tasks

@tparam Ts... parameter pack

@param tasks one or multiple tasks

@return @c *this

//template <typename... Ts>

//Task& precede(Ts&&... tasks);

template <typename T>

Task& precede(T&&);

template <typename T, typename... Ts>

Task& precede(T&&, Ts&&... tasks);

/**

@brief adds precedence links from this to others

@param tasks a vector of tasks to precede

@return @c *this

Task& precede(std::vector<Task>& tasks);

/**

@brief adds precedence links from this to others

@param tasks an initializer list of tasks to precede

@return @c *this

Task& precede(std::initializer_list<Task> tasks);

/**

@brief adds precedence links from other tasks to this

@tparam Ts parameter pack

@param tasks one or multiple tasks

@return @c *this

template <typename T>

Task& succeed(T&&);

template <typename T, typename... Ts>

Task& succeed(T&&, Ts&&... tasks);

/**

@brief adds precedence links from other tasks to this

@param tasks a vector of tasks

@return @c *this

Task& succeed(std::vector<Task>& tasks);

/**

@brief adds precedence links from other tasks to this

@param tasks an initializer list of tasks

@return @c *this

Task& succeed(std::initializer_list<Task> tasks);

/**

@brief adds precedence links from other tasks to this

@tparam Ts parameter pack

@param tasks one or multiple tasks

@return @c *this

//template <typename... Ts>

//Task& gather(Ts&&... tasks);

template <typename T>

Task& gather(T&&);

template <typename T, typename... Ts>

Task& gather(T&&, Ts&&... tasks);

/**

@brief adds precedence links from other tasks to this

@param tasks a vector of tasks

@return @c *this

Task& gather(std::vector<Task>& tasks);

/**

@brief adds precedence links from other tasks to this

@param tasks an initializer list of tasks

@return @c *this

Task& gather(std::initializer_list<Task> tasks);

/**

@brief resets the task handle to point to nothing

@return @c *this

Task& reset();

/**

@brief queries if the task handle points to a task node

bool empty() const;

private:

Task(Node&);

Task(Node*);

Node* _node {nullptr};

template <typename S>

void _gather(S&);

template <typename S>

void _precede(S&);

template <typename S>

void _succeed(S&);

};

// Constructor

inline Task::Task(Node& node) : _node {&node} {

}

// Constructor

inline Task::Task(Node* node) : _node {node} {

}

// Constructor

inline Task::Task(const Task& rhs) : _node {rhs._node} {

}

//// Function: precede

//template <typename... Ts>

//Task& Task::precede(Ts&&... tgts) {

// (_node->precede(*(tgts._node)), ...);

// return *this;

//}

// Function: precede

template <typename T>

inline Task& Task::precede(T&& t) {

_node->precede(*(t._node));

return *this;

}

// Function: precede

template <typename T, typename... Ts>

inline Task& Task::precede(T&& t, Ts&&... tgts) {

_node->precede(*(t._node));

precede(std::forward<Ts>(tgts)...);

return *this;

}

// Function: precede

inline Task& Task::precede(std::vector<Task>& tgts) {

_precede(tgts);

return *this;

}

// Function: precede

inline Task& Task::precede(std::initializer_list<Task> tgts) {

_precede(tgts);

return *this;

}

//// Function: gather

//template <typename... Bs>

//Task& Task::gather(Bs&&... tgts) {

// (tgts._node->precede(*_node), ...);

// return *this;

//}

// Function: gather

template <typename B>

Task& Task::gather(B&& b) {

b._node->precede(*_node);

return *this;

}

// Function: gather

template <typename B, typename... Bs>

Task& Task::gather(B&& b, Bs&&... tgts) {

b._node->precede(*_node);

gather(std::forward<Bs>(tgts)...);

return *this;

}

// Procedure: _gather

template <typename S>

void Task::_gather(S& tgts) {

for(auto& from : tgts) {

from._node->precede(*_node);

}

// Procedure: _precede

template <typename S>

void Task::_precede(S& tgts) {

for(auto& to : tgts) {

_node->precede(*(to._node));

}

template <typename T>

inline Task& Task::succeed(T&& t) {

t._node.precede(*_node);

return *this;

}

// Function: precede

template <typename T, typename... Bs>

inline Task& Task::succeed(T&& t, Bs&&... tgts) {

t._node.precede(*_node);

succeed(std::forward<Bs>(tgts)...);

return *this;

}

// Procedure: _succeed

template <typename S>

inline void Task::_succeed(S& tgts) {

for(auto& from : tgts) {

from._node->precede(*_node);

}

// Function: succeed

inline Task& Task::succeed(std::vector<Task>& tgts) {

_succeed(tgts);

return *this;

}

// Function: succeed

inline Task& Task::succeed(std::initializer_list<Task> tgts) {

_succeed(tgts);

return *this;

}

// Function: gather

inline Task& Task::gather(std::vector<Task>& tgts) {

_gather(tgts);

return *this;

}

// Function: gather

inline Task& Task::gather(std::initializer_list<Task> tgts) {

_gather(tgts);

return *this;

}

// Operator =

inline Task& Task::operator = (const Task& rhs) {

_node = rhs._node;

return *this;

}

// Operator =

inline Task& Task::operator = (std::nullptr_t ptr) {

_node = ptr;

return *this;

}

// Function: work

template <typename C>

inline Task& Task::work(C&& c) {

if(_node->_module) {

TF_THROW(Error::TASKFLOW, "can't assign work to a module task");

}

_node->_work = std::forward<C>(c);

return *this;

}

// Function: name

inline Task& Task::name(const std::string& name) {

_node->_name = name;

return *this;

}

// Procedure: reset

inline Task& Task::reset() {

_node = nullptr;

return *this;

}

// Function: name

inline const std::string& Task::name() const {

return _node->_name;

}

// Function: num_dependents

inline size_t Task::num_dependents() const {

return _node->num_dependents();

}

// Function: num_successors

inline size_t Task::num_successors() const {

return _node->num_successors();

}

// Function: empty

inline bool Task::empty() const {

return _node == nullptr;

}

// ----------------------------------------------------------------------------

/**

@class TaskView

@brief A constant wrapper class to a task node,

mainly used in the tf::ExecutorObserver interface.

class TaskView {

friend class Executor;

public:

/**

@brief constructs an empty task view

TaskView() = default;

/**

@brief constructs a task view from a task

TaskView(const Task& task);

/**

@brief constructs the task with the copy of the other task

TaskView(const TaskView& other);

/**

@brief replaces the contents with a copy of the other task

TaskView& operator = (const TaskView& other);

/**

@brief replaces the contents with another task

TaskView& operator = (const Task& other);

/**

@brief replaces the contents with a null pointer

TaskView& operator = (std::nullptr_t);

/**

@brief queries the name of the task

const std::string& name() const;

/**

@brief queries the number of successors of the task

size_t num_successors() const;

/**

@brief queries the number of predecessors of the task

size_t num_dependents() const;

/**

@brief resets to an empty view

void reset();

/**

@brief queries if the task view is empty

bool empty() const;

private:

TaskView(Node&);

TaskView(Node*);

Node* _node {nullptr};

};

// Constructor

inline TaskView::TaskView(Node& node) : _node {&node} {

}

// Constructor

inline TaskView::TaskView(Node* node) : _node {node} {

}

// Constructor

inline TaskView::TaskView(const TaskView& rhs) : _node {rhs._node} {

}

// Constructor

inline TaskView::TaskView(const Task& task) : _node {task._node} {

}

// Operator =

inline TaskView& TaskView::operator = (const TaskView& rhs) {

_node = rhs._node;

return *this;

}

// Operator =

inline TaskView& TaskView::operator = (const Task& rhs) {

_node = rhs._node;

return *this;

}

// Operator =

inline TaskView& TaskView::operator = (std::nullptr_t ptr) {

_node = ptr;

return *this;

}

// Function: name

inline const std::string& TaskView::name() const {

return _node->_name;

}

// Function: num_dependents

inline size_t TaskView::num_dependents() const {

return _node->num_dependents();

}

// Function: num_successors

inline size_t TaskView::num_successors() const {

return _node->num_successors();

}

// Function: reset

inline void TaskView::reset() {

_node = nullptr;

}

// Function: empty

inline bool TaskView::empty() const {

return _node == nullptr;

}

} // end of namespace tf. ---------------------------------------------------

cpp-taskflow/taskflow/core/task.hpp at cpp14 · gicho/cpp-taskflow · GitHub

Repository navigation

Expand file tree

Breadcrumbs

task.hpp

Latest commit

History

Breadcrumbs

task.hpp

File metadata and controls